libssh2/docs/libssh2_channel_forward_accept.3

.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_channel_forward_accept - accept a queued connection
.SH SYNOPSIS
#include <libssh2.h>

LIBSSH2_CHANNEL *
libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);

.SH DESCRIPTION
\fIlistener\fP is a forwarding listener instance as returned by
\fBlibssh2_channel_forward_listen_ex(3)\fP.
.SH RETURN VALUE
A newly allocated channel instance or NULL on failure.
.SH ERRORS
When this function returns NULL use \fIlibssh2_session_last_errno(3)\fP to
extract the error code. If that code is \fILIBSSH2_ERROR_EAGAIN\fP, the
session is set to do non-blocking I/O but the call would block.
.SH SEE ALSO
.BR libssh2_channel_forward_listen_ex(3)
The month should be the 3-letter abbreviation instead of spelled out. 2007-06-13 16:41:33 +00:00			`.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"`
Added an initial set of man pages. 2006-12-21 14:09:12 +00:00			`.SH NAME`
			`libssh2_channel_forward_accept - accept a queued connection`
			`.SH SYNOPSIS`
Update to match current code and add errors 2007-06-13 12:58:58 +00:00			`#include <libssh2.h>`

			`LIBSSH2_CHANNEL *`
			`libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);`
Added an initial set of man pages. 2006-12-21 14:09:12 +00:00
			`.SH DESCRIPTION`
			`\fIlistener\fP is a forwarding listener instance as returned by`
cleanup round 2009-03-16 23:25:14 +00:00			`\fBlibssh2_channel_forward_listen_ex(3)\fP.`
Added an initial set of man pages. 2006-12-21 14:09:12 +00:00			`.SH RETURN VALUE`
			`A newly allocated channel instance or NULL on failure.`
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 12:34:06 +00:00			`.SH ERRORS`
libssh2_channel_forward_accept.3: mention how to get error Since this returns a pointer, libssh2_session_last_errno() must be used to get the actual error code and it wasn't that clear before. 2011-05-17 19:32:56 +02:00			`When this function returns NULL use \fIlibssh2_session_last_errno(3)\fP to`
			`extract the error code. If that code is \fILIBSSH2_ERROR_EAGAIN\fP, the`
			`session is set to do non-blocking I/O but the call would block.`
Change "SEE ALSO" to SEE ALSO 2007-06-13 12:51:10 +00:00			`.SH SEE ALSO`
cleanup round 2009-03-16 23:25:14 +00:00			`.BR libssh2_channel_forward_listen_ex(3)`