libssh2/docs/libssh2_sftp_init.3

.\" $Id: libssh2_sftp_init.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $
.\"
.TH libssh2_sftp_init 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_sftp_init - 
.SH SYNOPSIS
#include <libssh2.h>
#include <libssh2_sftp.h>

LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session);
.SH DESCRIPTION
Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem
operates over the same type of channel as those exported by the Channel API,
the protocol itself implements its own unique binary packet protocol which
must be managed with the libssh2_sftp_*() family of functions. When an SFTP
session is complete, it must be destroyed using the
\fIlibssh2_sftp_shutdown(3)\fP function.
.SH RETURN VALUE
A pointer to the newly allocated SFTP instance or NULL on failure.
.SH ERRORS
LIBSSH2_ERROR_EAGAIN
Marked for non-blocking I/O but the call would block.
.SH SEE ALSO
.BI libssh2_sftp_shutdown(3), libssh2_sftp_open_ex(3)
Change "SEE ALSO" to SEE ALSO 2007-06-13 12:51:10 +00:00			`.\" $Id: libssh2_sftp_init.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $`
more docs, including a template.3 for new man pages 2007-02-02 16:09:12 +00:00			`.\"`
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			`.TH libssh2_sftp_init 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"`
more docs, including a template.3 for new man pages 2007-02-02 16:09:12 +00:00			`.SH NAME`
			`libssh2_sftp_init -`
			`.SH SYNOPSIS`
			`#include <libssh2.h>`
libssh2_sftp.h is needed for all of these functions 2007-04-22 17:18:03 +00:00			`#include <libssh2_sftp.h>`
more docs, including a template.3 for new man pages 2007-02-02 16:09:12 +00:00
			`LIBSSH2_SFTP libssh2_sftp_init(LIBSSH2_SESSION session);`
			`.SH DESCRIPTION`
			`Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem`
			`operates over the same type of channel as those exported by the Channel API,`
			`the protocol itself implements its own unique binary packet protocol which`
			`must be managed with the libssh2_sftp_*() family of functions. When an SFTP`
			`session is complete, it must be destroyed using the`
			`\fIlibssh2_sftp_shutdown(3)\fP function.`
			`.SH RETURN VALUE`
			`A pointer to the newly allocated SFTP 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_ERROR_EAGAIN`
			`Marked for 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`
more docs, including a template.3 for new man pages 2007-02-02 16:09:12 +00:00			`.BI libssh2_sftp_shutdown(3), libssh2_sftp_open_ex(3)`