lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Code Activity

timeout: added man pages

Browse Source
This commit is contained in:
Daniel Stenberg
2011-05-04 23:26:26 +02:00
parent 4ed1e9d96b
commit 26dad4590b
3 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/libssh2_session_set_timeout.3 Normal file
View File

@ -0,0 +1,18 @@
.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
.SH NAME
libssh2_session_set_timeout - set timeout for blocking functions
.SH SYNOPSIS
#include <libssh2.h>
.nf
void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout);
.SH DESCRIPTION
Set 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 or if you set the timeout to zero, libssh2 has no timeout for
blocking functions.
.SH RETURN VALUE
Nothing
.SH SEE ALSO
.BR libssh2_session_get_timeout(3)