libssh2/share/man/man3/libssh2_channel_close.3

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