libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2" "libssh2"
4
.SH NAME
5
libssh2_keepalive_send - short function description
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_keepalive_send(LIBSSH2_SESSION *session,
12
                       int *seconds_to_next);
13
.fi
14
.SH DESCRIPTION
15
Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many
16
seconds you can sleep after this call before you need to call it again.
17
.SH RETURN VALUE
18
Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.
19
.SH AVAILABILITY
20
Added in libssh2 1.2.5
21
.SH SEE ALSO
22
.BR libssh2_keepalive_config(3)
23