ssh2/docs/libssh2_session_startup.3

.\" $Id: libssh2_session_startup.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $
.\"
.TH libssh2_session_startup 3 "1 June 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
Begin transport layer protocol negotiation with the connected host.
.SH RETURN VALUE
0 on success, \-1 on failure
.SH ERRORS
LIBSSH2_ERROR_SOCKET_NONE
Bad socket provided.
.br
LIBSSH2_ERROR_BANNER_SEND
Error sending banner to remote host.
.br
LIBSSH2_ERROR_KEX_FAILURE
Unable to exchange encryption keys.
.br
LIBSSH2_ERROR_SOCKET_SEND
Unable to ask for ssh-userauth service.
.br
LIBSSH2_ERROR_SOCKET_DISCONNECT
Connection was lost.
.br
LIBSSH2_ERROR_PROTO
Invalid response received from server.
.br
LIBSSH2_ERROR_EAGAIN
Marked for non-blocking I/O but the call would block.
.SH SEE ALSO
.BI libssh2_session_free(3),
.BI libssh2_session_init(3)
Change "SEE ALSO" to SEE ALSO 2007-06-13 14:51:10 +02:00			`.\" $Id: libssh2_session_startup.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $`
Added an initial set of man pages. 2006-12-21 15:09:12 +01: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 14:34:06 +02:00			`.TH libssh2_session_startup 3 "1 June 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>`

			`int libssh2_session_startup(LIBSSH2_SESSION *session, int socket);`
			`.SH DESCRIPTION`
			`Begin transport layer protocol negotiation with the connected host.`
			`.SH RETURN VALUE`
Minus sign escaped to not be treated as emdash in man pages. 2007-01-02 06:47:00 +01:00			`0 on success, \-1 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`
			`LIBSSH2_ERROR_SOCKET_NONE`
			`Bad socket provided.`
			`.br`
			`LIBSSH2_ERROR_BANNER_SEND`
			`Error sending banner to remote host.`
			`.br`
			`LIBSSH2_ERROR_KEX_FAILURE`
			`Unable to exchange encryption keys.`
			`.br`
			`LIBSSH2_ERROR_SOCKET_SEND`
			`Unable to ask for ssh-userauth service.`
			`.br`
			`LIBSSH2_ERROR_SOCKET_DISCONNECT`
			`Connection was lost.`
			`.br`
			`LIBSSH2_ERROR_PROTO`
			`Invalid response received from server.`
			`.br`
			`LIBSSH2_ERROR_EAGAIN`
			`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`
Added an initial set of man pages. 2006-12-21 15:09:12 +01:00			`.BI libssh2_session_free(3),`
			`.BI libssh2_session_init(3)`