xref: /freebsd/secure/lib/libcrypto/man/man3/DTLS_set_timer_cb.3 (revision 18a870751b036f1dc78b36084ccb993d139a11bb)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "DTLS_SET_TIMER_CB 3ossl"
DTLS_SET_TIMER_CB 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
DTLS_timer_cb, DTLS_set_timer_cb \- Set callback for controlling DTLS timer duration
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us); \& void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb); .Ve
DESCRIPTION
Header "DESCRIPTION" This function sets an optional callback function for controlling the timeout interval on the DTLS protocol. The callback function will be called by DTLS for every new DTLS packet that is sent.

The callback should return the timeout interval in micro seconds.

The timer_us parameter of the callback is the last set timeout interval returned. On the first invocation of the callback, this value will be 0.

At the beginning of the connection, if no timeout callback has been set via DTLS_set_timer_cb(), the default timeout value is 1 second. For all subsequent timeouts, the default behavior is to double the duration up to a maximum of 1 minute.

"RETURN VALUES"
Header "RETURN VALUES" Returns void.
HISTORY
Header "HISTORY" The DTLS_set_timer_cb() function was added in OpenSSL 1.1.1.
COPYRIGHT
Header "COPYRIGHT" Copyright 2017-2025 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.