libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_session_set_read_timeout 3 "13 Jan 2023" "libssh2" "libssh2"
4
.SH NAME
5
libssh2_session_set_read_timeout - set timeout for packet read functions
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
void
11
libssh2_session_set_read_timeout(LIBSSH2_SESSION *session, long timeout);
12
.fi
13
.SH DESCRIPTION
14
Set the \fBtimeout\fP in seconds for how long libssh2 packet read
15
function calls may wait until they consider the situation an error and return
16
LIBSSH2_ERROR_TIMEOUT.
17

18
By default or if you set the timeout to zero, the timeout will be set to
19
60 seconds.
20
.SH RETURN VALUE
21
Nothing
22
.SH AVAILABILITY
23
Added in 1.10.1
24
.SH SEE ALSO
25
.BR libssh2_session_get_read_timeout(3)
26