Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_keepalive_config (3ssh2)

Name

libssh2_keepalive_config - short function description

Synopsis

#include <libssh2.h>

void libssh2_keepalive_config(LIBSSH2_SESSION *session,
int want_reply,
unsigned interval);

Description

libssh2 manual                                 libssh2_keepalive_config(3ssh2)



NAME
       libssh2_keepalive_config - short function description

SYNOPSIS
       #include <libssh2.h>

       void libssh2_keepalive_config(LIBSSH2_SESSION *session,
                                     int want_reply,
                                     unsigned interval);

DESCRIPTION
       Set  how  often keepalive messages should be sent. want_reply indicates
       whether the keepalive messages  should  request  a  response  from  the
       server.   interval  is number of seconds that can pass without any I/O,
       use 0 (the default) to disable keepalives.   To  avoid  some  busy-loop
       corner-cases, if you specify an interval of 1 it will be treated as 2.

       Note  that  non-blocking  applications  are responsible for sending the
       keepalive messages using libssh2_keepalive_send(3).

RETURN VALUE
       Nothing

AVAILABILITY
       Added in libssh2 1.2.5


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


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

SEE ALSO
       libssh2_keepalive_send(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.5                     12 Apr 2011
                                               libssh2_keepalive_config(3ssh2)