Skip to content

Commit 49885ae

Browse files
noctuellest8m
authored andcommitted
fix: Better documentation on DTLS_set_timer_cb()
Also more precise description of DTLS timeout mechanism. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from openssl#27800)
1 parent 5ee8248 commit 49885ae

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/man3/DTLS_set_timer_cb.pod

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ This function sets an optional callback function for controlling the
2020
timeout interval on the DTLS protocol. The callback function will be
2121
called by DTLS for every new DTLS packet that is sent.
2222

23+
The callback should return the timeout interval in micro seconds.
24+
25+
The I<timer_us> parameter of the callback is the last set timeout
26+
interval returned. On the first invocation of the callback,
27+
this value will be 0.
28+
29+
At the beginning of the connection, if no timeout callback has been
30+
set via DTLS_set_timer_cb(), the default timeout value is 1 second.
31+
For all subsequent timeouts, the default behavior is to double the
32+
duration up to a maximum of 1 minute.
33+
2334
=head1 RETURN VALUES
2435

2536
Returns void.

0 commit comments

Comments
 (0)