.\"	$NetBSD: DTLS_set_timer_cb.3,v 1.2 2025/07/18 16:41:11 christos Exp $
.\"
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" 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'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "DTLS_set_timer_cb 3"
.TH DTLS_set_timer_cb 3 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.
.if n .ad l
.nh
.SH NAME
DTLS_timer_cb,
DTLS_set_timer_cb
\&\- Set callback for controlling DTLS timer duration
.SH SYNOPSIS
.IX 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
.SH DESCRIPTION
.IX 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.
.PP
The callback should return the timeout interval in micro seconds.
.PP
The \fItimer_us\fR parameter of the callback is the last set timeout
interval returned. On the first invocation of the callback,
this value will be 0.
.PP
At the beginning of the connection, if no timeout callback has been
set via \fBDTLS_set_timer_cb()\fR, 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.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
Returns void.
.SH HISTORY
.IX Header "HISTORY"
The \fBDTLS_set_timer_cb()\fR function was added in OpenSSL 1.1.1.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2017\-2025 The OpenSSL Project Authors. All Rights Reserved.
.PP
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>.