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
23 lines
650 B
Groff
23 lines
650 B
Groff
.TH libssh2_session_get_read_timeout 3 "13 Jan 2023" "libssh2 1.10.1" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_get_read_timeout - get the timeout for packet read functions
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
long
|
|
libssh2_session_get_read_timeout(LIBSSH2_SESSION *session);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Returns the \fBtimeout\fP (in seconds) for how long the ssh2 packet receive
|
|
function calls may wait until they consider the situation an error and
|
|
return LIBSSH2_ERROR_TIMEOUT.
|
|
|
|
By default the timeout is 60 seconds.
|
|
.SH RETURN VALUE
|
|
The value of the timeout setting.
|
|
.SH AVAILABILITY
|
|
Added in 1.10.1
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_set_read_timeout(3)
|