src/vendor/libssh2-sys/libssh2/docs/libssh2_channel_close.3

   1 .TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   2 .SH NAME
   3 libssh2_channel_close - close a channel
   4 .SH SYNOPSIS
   5 #include <libssh2.h>
   6
   7 int
   8 libssh2_channel_close(LIBSSH2_CHANNEL *channel);
   9
  10 .SH DESCRIPTION
  11 \fIchannel\fP - active channel stream to set closed status on.
  12
  13 Close an active data channel. In practice this means sending an SSH_MSG_CLOSE
  14 packet to the remote host which serves as instruction that no further data
  15 will be sent to it. The remote host may still send data back until it sends
  16 its own close message in response. To wait for the remote end to close its
  17 connection as well, follow this command with
  18 .BR libssh2_channel_wait_closed(3)
  19
  20 .SH RETURN VALUE
  21 Return 0 on success or negative on failure.  It returns
  22 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  23 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  24
  25 .SH ERRORS
  26 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  27
  28 .SH SEE ALSO
  29 .BR libssh2_channel_open_ex(3)