mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-26 16:48:48 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
21 lines
613 B
Groff
21 lines
613 B
Groff
.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2 1.2.5" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_keepalive_send - short function description
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_keepalive_send(LIBSSH2_SESSION *session,
|
|
int *seconds_to_next);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many
|
|
seconds you can sleep after this call before you need to call it again.
|
|
.SH RETURN VALUE
|
|
Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.
|
|
.SH AVAILABILITY
|
|
Added in libssh2 1.2.5
|
|
.SH SEE ALSO
|
|
.BR libssh2_keepalive_config(3)
|