libssh2/share/man/man3/libssh2_channel_send_eof.3

   1 .\" $Id: libssh2_channel_send_eof.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_send_eof - send EOF to remote server
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
  11
  12 .SH DESCRIPTION
  13 Tell the remote host that no further data will be sent on the specified
  14 channel. Processes typically interpret this as a closed stdin descriptor.
  15
  16 .SH RETURN VALUE
  17 Return 0 on success or negative on failure.  It returns
  18 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  19 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  20
  21 .SH ERRORS
  22 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  23
  24 .SH SEE ALSO
  25 .BR libssh2_channel_wait_eof(3)
  26 .BR libssh2_channel_eof(3)