Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_keepalive_send (3ssh2)

Name

libssh2_keepalive_send - short function description

Synopsis

#include <libssh2.h>

int libssh2_keepalive_send(LIBSSH2_SESSION *session,
int *seconds_to_next);

Description

libssh2 manual                                   libssh2_keepalive_send(3ssh2)



NAME
       libssh2_keepalive_send - short function description

SYNOPSIS
       #include <libssh2.h>

       int libssh2_keepalive_send(LIBSSH2_SESSION *session,
                                  int *seconds_to_next);

DESCRIPTION
       Send a keepalive message if needed.  seconds_to_next indicates how many
       seconds you can sleep after this call before you need to call it again.

RETURN VALUE
       Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.

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_config(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                     13 Apr 2011
                                                 libssh2_keepalive_send(3ssh2)