libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2" "libssh2"
4
.SH NAME
5
libssh2_session_get_timeout - get the timeout for blocking functions
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
long
11
libssh2_session_get_timeout(LIBSSH2_SESSION *session);
12
.fi
13
.SH DESCRIPTION
14
Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the
15
libssh2 function calls may wait until they consider the situation an error and
16
return LIBSSH2_ERROR_TIMEOUT.
17

18
By default libssh2 has no timeout (zero) for blocking functions.
19
.SH RETURN VALUE
20
The value of the timeout setting.
21
.SH AVAILABILITY
22
Added in 1.2.9
23
.SH SEE ALSO
24
.BR libssh2_session_set_timeout(3)
25