summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_dtls_get_timeout
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_dtls_get_timeout')
-rw-r--r--doc/functions/gnutls_dtls_get_timeout17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/functions/gnutls_dtls_get_timeout b/doc/functions/gnutls_dtls_get_timeout
new file mode 100644
index 0000000..8f50a9a
--- /dev/null
+++ b/doc/functions/gnutls_dtls_get_timeout
@@ -0,0 +1,17 @@
+
+
+
+
+@deftypefun {unsigned int} {gnutls_dtls_get_timeout} (gnutls_session_t @var{session})
+@var{session}: is a @code{gnutls_session_t} type.
+
+This function will return the milliseconds remaining
+for a retransmission of the previously sent handshake
+message. This function is useful when DTLS is used in
+non-blocking mode, to estimate when to call @code{gnutls_handshake()}
+if no packets have been received.
+
+@strong{Returns:} the remaining time in milliseconds.
+
+@strong{Since:} 3.0
+@end deftypefun