libssh2/docs/libssh2_channel_wait_closed.md

c, SPDX-License-Identifier, Title, Section, Source, See-also

c	SPDX-License-Identifier	Title	Section	Source	See-also
Copyright (C) The libssh2 project and its contributors.	BSD-3-Clause	libssh2_channel_wait_closed	3	libssh2	libssh2_channel_eof(3) libssh2_channel_send_eof(3) libssh2_channel_wait_eof(3)

NAME

libssh2_channel_wait_closed - wait for the remote to close the channel

SYNOPSIS

#include <libssh2.h>

int libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);

DESCRIPTION

Enter a temporary blocking state until the remote host closes the named channel. Typically sent after libssh2_channel_close(3) in order to examine the exit status.

RETURN VALUE

Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.