4b8db8c1ab
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.
20 lines
686 B
Groff
20 lines
686 B
Groff
.\" $Id: libssh2_channel_wait_eof.3,v 1.1 2007/06/06 12:34:06 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
|
|
LIBSSH2CHANNEL_EAGAIN when it would otherwise block. While
|
|
LIBSSH2CHANNEL_EAGAIN is a negative number, it isn't really a failure per se.
|
|
.SH "SEE ALSO"
|
|
.BI libssh2_channel_send_eof(3), libssh2_channel_eof(3)
|