Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_session_get_timeout (3ssh2)

Name

libssh2_session_get_timeout - get the timeout for blocking functions

Synopsis

#include <libssh2.h>
long libssh2_session_get_timeout(LIBSSH2_SESSION *session);

Description

libssh2 manual                              libssh2_session_get_timeout(3ssh2)



NAME
       libssh2_session_get_timeout - get the timeout for blocking functions

SYNOPSIS
       #include <libssh2.h>
       long libssh2_session_get_timeout(LIBSSH2_SESSION *session);

DESCRIPTION
       Returns  the timeout (in milliseconds) for how long a blocking the lib-
       ssh2 function calls may wait until they consider the situation an error
       and return LIBSSH2_ERROR_TIMEOUT.

       By default libssh2 has no timeout (zero) for blocking functions.

RETURN VALUE
       The value of the timeout setting.

AVAILABILITY
       Added in 1.2.9


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


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

SEE ALSO
       libssh2_session_set_timeout(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 1.2.9                     4 May 2011
                                            libssh2_session_get_timeout(3ssh2)