summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_handshake_set_timeout
blob: 52854d3bad188a04b66c874d7461088da1603c11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
@deftypefun {void} {gnutls_handshake_set_timeout} (gnutls_session_t @var{session}, unsigned int @var{ms})
@var{session}: is a @code{gnutls_session_t}  type.

@var{ms}: is a timeout value in milliseconds

This function sets the timeout for the TLS handshake process
to the provided value. Use an  @code{ms} value of zero to disable
timeout, or @code{GNUTLS_DEFAULT_HANDSHAKE_TIMEOUT}  for a reasonable
default value. For the DTLS protocol, the more detailed
@code{gnutls_dtls_set_timeouts()}  is provided.

This function requires to set a pull timeout callback. See
@code{gnutls_transport_set_pull_timeout_function()} .

@strong{Since:} 3.1.0
@end deftypefun