Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_wait_closed (3ssh2)

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

libssh2 manual                              libssh2_channel_wait_closed(3ssh2)



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  LIB-
       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB-
       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
       se.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_channel_send_eof(3)    libssh2_channel_eof(3)     libssh2_chan-
       nel_wait_eof(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.19                      29 Nov 2007
                                            libssh2_channel_wait_closed(3ssh2)