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