summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_record_set_timeout.3
blob: ba68c50dba7702075f5d5c490879c812c74f6764 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_record_set_timeout" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_record_set_timeout \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "void gnutls_record_set_timeout(gnutls_session_t " session ", unsigned int " ms ");"
.SH ARGUMENTS
.IP "gnutls_session_t session" 12
is a \fBgnutls_session_t\fP type.
.IP "unsigned int ms" 12
is a timeout value in milliseconds
.SH "DESCRIPTION"
This function sets the receive timeout for the record layer
to the provided value. Use an  \fIms\fP value of zero to disable
timeout (the default), or \fBGNUTLS_INDEFINITE_TIMEOUT\fP, to
set an indefinite timeout.

This function requires to set a pull timeout callback. See
\fBgnutls_transport_set_pull_timeout_function()\fP.
.SH "SINCE"
3.1.7
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP