mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-31 23:30:25 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
44 lines
1014 B
Markdown
44 lines
1014 B
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_keepalive_config
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_keepalive_send(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_keepalive_config - short function description
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
void
|
|
libssh2_keepalive_config(LIBSSH2_SESSION *session,
|
|
int want_reply,
|
|
unsigned int 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
|