mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-02 22:02:25 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
23 lines
642 B
Groff
23 lines
642 B
Groff
.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_session_get_timeout - get the timeout for blocking functions
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
long
|
|
libssh2_session_get_timeout(LIBSSH2_SESSION *session);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the
|
|
libssh2 function calls may wait until they consider the situation an error and
|
|
return LIBSSH2_ERROR_TIMEOUT.
|
|
|
|
By default libssh2 has no timeout (zero) for blocking functions.
|
|
.SH RETURN VALUE
|
|
The value of the timeout setting.
|
|
.SH AVAILABILITY
|
|
Added in 1.2.9
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_set_timeout(3)
|