ssh2/docs/libssh2_channel_wait_eof.3

.\" $Id: libssh2_channel_wait_eof.3,v 1.4 2007/06/13 13:11:03 jehousley Exp $
.\"
.TH libssh2_channel_wait_eof 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_channel_wait_eof - wait for the remote to reply to an EOF request
.SH SYNOPSIS
#include <libssh2.h>

int 
libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);

.SH DESCRIPTION
Wait for the remote end to acknowledge an EOF request.

.SH RETURN VALUE
Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH SEE ALSO
.BR libssh2_channel_send_eof(3)
.BR libssh2_channel_eof(3)
Update to match current code and add errors 2007-06-13 15:06:48 +02:00			`.\" $Id: libssh2_channel_wait_eof.3,v 1.4 2007/06/13 13:11:03 jehousley Exp $`
Modify the code to truely support non-blocking. Propogate the EAGAIN error all the way up to the user interface. All code modules bug sftp.c have been completed. Functions that return an "int", or similar return LIBSSH2CHANNEL_EAGAIN to indicate some part of the call would block, in non-blocking mode. Functions that return a structure, like "LIBSSH2_CHANNEL *", return NULL and set the libssh2 error. The error can be obtained with either libssh2_session_last_error() or libssh2_session_last_errno(). Either of these will return the error code of LIBSSH2_ERROR_EAGAIN if the call would block, in non-blocking mode. The current state of a function and some variable are keep in the structures so that on the next call the operation that would block can be retried again with the same data. 2007-06-06 14:34:06 +02:00			`.\"`
			`.TH libssh2_channel_wait_eof 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"`
			`.SH NAME`
			`libssh2_channel_wait_eof - wait for the remote to reply to an EOF request`
			`.SH SYNOPSIS`
			`#include <libssh2.h>`

Update to match current code and add errors 2007-06-13 15:06:48 +02:00			`int`
			`libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);`
Modify the code to truely support non-blocking. Propogate the EAGAIN error all the way up to the user interface. All code modules bug sftp.c have been completed. Functions that return an "int", or similar return LIBSSH2CHANNEL_EAGAIN to indicate some part of the call would block, in non-blocking mode. Functions that return a structure, like "LIBSSH2_CHANNEL *", return NULL and set the libssh2 error. The error can be obtained with either libssh2_session_last_error() or libssh2_session_last_errno(). Either of these will return the error code of LIBSSH2_ERROR_EAGAIN if the call would block, in non-blocking mode. The current state of a function and some variable are keep in the structures so that on the next call the operation that would block can be retried again with the same data. 2007-06-06 14:34:06 +02:00
			`.SH DESCRIPTION`
			`Wait for the remote end to acknowledge an EOF request.`

			`.SH RETURN VALUE`
			`Return 0 on success or negative on failure. It returns`
To simplify the user's error interface always use LIBSSH2_ERROR_EAGAIN. LIBSSH2CHANNEL_EAGAIN and LIBSSH2SFTP_EAGAIN are still valid, but are defined as LIBSSH2_ERROR_EAGAIN. 2007-06-08 15:33:08 +02:00			`LIBSSH2_ERROR_EAGAIN when it would otherwise block. While`
			`LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.`
Change "SEE ALSO" to SEE ALSO 2007-06-13 14:51:10 +02:00			`.SH SEE ALSO`
Update to match current code and add errors 2007-06-13 15:06:48 +02:00			`.BR libssh2_channel_send_eof(3)`
			`.BR libssh2_channel_eof(3)`