Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_session_startup (3ssh2)

Name

libssh2_session_startup - begin transport layer

Synopsis

#include <libssh2.h>

int libssh2_session_startup(LIBSSH2_SESSION *session, int socket);

Description

libssh2 manual                                  libssh2_session_startup(3ssh2)



NAME
       libssh2_session_startup - begin transport layer

SYNOPSIS
       #include <libssh2.h>

       int libssh2_session_startup(LIBSSH2_SESSION *session, int socket);

DESCRIPTION
       Starting  in  libssh2  version 1.2.8 this function is considered depre-
       cated. Use libssh2_session_handshake(3) instead.

       session - Session instance as returned by libssh2_session_init_ex(3)

       socket - 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.

RETURN VALUE
       Returns 0 on success, negative on failure.

ERRORS
       LIBSSH2_ERROR_SOCKET_NONE - The socket is invalid.

       LIBSSH2_ERROR_BANNER_SEND - Unable to send banner to remote host.

       LIBSSH2_ERROR_KEX_FAILURE - >Encryption key exchange  with  the  remote
       host failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_SOCKET_DISCONNECT - The socket was disconnected.

       LIBSSH2_ERROR_PROTO  - An invalid SSH protocol response was received on
       the socket.

       LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the  call  would
       block.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_session_free(3) libssh2_session_init_ex(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.15                      1 Jun 2007
                                                libssh2_session_startup(3ssh2)