summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_handshake_set_timeout
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_handshake_set_timeout
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_handshake_set_timeout')
-rw-r--r--doc/functions/gnutls_handshake_set_timeout20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/functions/gnutls_handshake_set_timeout b/doc/functions/gnutls_handshake_set_timeout
new file mode 100644
index 0000000..52854d3
--- /dev/null
+++ b/doc/functions/gnutls_handshake_set_timeout
@@ -0,0 +1,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