ssh2/docs/libssh2_session_startup.3

.\" $Id: libssh2_session_startup.3,v 1.6 2007/06/13 16:41:33 jehousley Exp $
.\"
.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_session_startup - begin transport layer
.SH SYNOPSIS
#include <libssh2.h>

int 
libssh2_session_startup(LIBSSH2_SESSION *session, int socket);

.SH DESCRIPTION
\fIsession\fP - Session instance as returned by 
.BR libssh2_session_init(3)

\fIsocket\fP - Connected socket descriptor. Typically a TCP connection 
though the protocol allows for any reliable transport and the library will 
attempt to use any berkeley socket.

Begin transport layer protocol negotiation with the connected host.
.SH RETURN VALUE
Returns 0 on success, negative on failure.
.SH ERRORS
\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid.

\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host.

\fILIBSSH2_ERROR_KEX_FAILURE\fP - >Encryption key exchange with the remote 
host failed.

\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.

\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected.

\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on 
the socket.

\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.

.SH SEE ALSO
.BR libssh2_session_free(3)
.BR libssh2_session_init(3)
The month should be the 3-letter abbreviation instead of spelled out. 2007-06-13 18:41:33 +02:00			`.\" $Id: libssh2_session_startup.3,v 1.6 2007/06/13 16:41:33 jehousley Exp $`
Added an initial set of man pages. 2006-12-21 15:09:12 +01:00			`.\"`
The month should be the 3-letter abbreviation instead of spelled out. 2007-06-13 18:41:33 +02:00			`.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"`
Added an initial set of man pages. 2006-12-21 15:09:12 +01:00			`.SH NAME`
			`libssh2_session_startup - begin transport layer`
			`.SH SYNOPSIS`
			`#include <libssh2.h>`

Update to match current code and add errors 2007-06-13 16:07:12 +02:00			`int`
			`libssh2_session_startup(LIBSSH2_SESSION *session, int socket);`

Added an initial set of man pages. 2006-12-21 15:09:12 +01:00			`.SH DESCRIPTION`
Update to match current code and add errors 2007-06-13 16:07:12 +02:00			`\fIsession\fP - Session instance as returned by`
			`.BR libssh2_session_init(3)`

			`\fIsocket\fP - Connected socket descriptor. Typically a TCP connection`
			`though the protocol allows for any reliable transport and the library will`
			`attempt to use any berkeley socket.`

Added an initial set of man pages. 2006-12-21 15:09:12 +01:00			`Begin transport layer protocol negotiation with the connected host.`
			`.SH RETURN VALUE`
Update to match current code and add errors 2007-06-13 16:07:12 +02:00			`Returns 0 on success, negative 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 14:34:06 +02:00			`.SH ERRORS`
Update to match current code and add errors 2007-06-13 16:07:12 +02:00			`\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid.`

			`\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host.`

			`\fILIBSSH2_ERROR_KEX_FAILURE\fP - >Encryption key exchange with the remote`
			`host failed.`

			`\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.`

			`\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected.`

			`\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on`
			`the socket.`

			`\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.`

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 16:07:12 +02:00			`.BR libssh2_session_free(3)`
			`.BR libssh2_session_init(3)`