libssh2_channel_close - close a channel
#include <libssh2.h> int libssh2_channel_close(LIBSSH2_CHANNEL *channel);
libssh2 manual libssh2_channel_close(3ssh2)
NAME
libssh2_channel_close - close a channel
SYNOPSIS
#include <libssh2.h>
int libssh2_channel_close(LIBSSH2_CHANNEL *channel);
DESCRIPTION
channel - active channel stream to set closed status on.
Close an active data channel. In practice this means sending an
SSH_MSG_CLOSE packet to the remote host which serves as instruction
that no further data will be sent to it. The remote host may still send
data back until it sends its own close message in response. To wait for
the remote end to close its connection as well, follow this command
with libssh2_channel_wait_closed(3)
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.
ERRORS
LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_channel_open_ex(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.15 1 Jun 2007
libssh2_channel_close(3ssh2)