libssh2_session_startup.3 (1376B)
1.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_session_startup - begin transport layer 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_startup(LIBSSH2_SESSION *session, int socket); 10.fi 11.SH DESCRIPTION 12Starting in libssh2 version 1.2.8 this function is considered deprecated. Use 13\fIlibssh2_session_handshake(3)\fP instead. 14 15\fIsession\fP - Session instance as returned by 16.BR libssh2_session_init_ex(3) 17 18\fIsocket\fP - Connected socket descriptor. Typically a TCP connection 19though the protocol allows for any reliable transport and the library will 20attempt to use any berkeley socket. 21 22Begin transport layer protocol negotiation with the connected host. 23.SH RETURN VALUE 24Returns 0 on success, negative on failure. 25.SH ERRORS 26\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid. 27 28\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host. 29 30\fILIBSSH2_ERROR_KEX_FAILURE\fP - Encryption key exchange with the remote 31host failed. 32 33\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 34 35\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected. 36 37\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on 38the socket. 39 40\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. 41.SH SEE ALSO 42.BR libssh2_session_free(3) 43.BR libssh2_session_init_ex(3)