Debian Codegraph @

upstream/debian-unstable/man3/DTLS_set_timer_cb.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "DTLS_SET_TIMER_CB 3SSL"
58 .TH DTLS_SET_TIMER_CB 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 DTLS_timer_cb,
65 DTLS_set_timer_cb
66 \&\- Set callback for controlling DTLS timer duration
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
73 \&
74 \& void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This function sets an optional callback function for controlling the
79 timeout interval on the DTLS protocol. The callback function will be
80 called by DTLS for every new DTLS packet that is sent.
81 .PP
82 The callback should return the timeout interval in micro seconds.
83 .PP
84 The \fItimer_us\fR parameter of the callback is the last set timeout
85 interval returned. On the first invocation of the callback,
86 this value will be 0.
87 .PP
88 At the beginning of the connection, if no timeout callback has been
89 set via \fBDTLS_set_timer_cb()\fR, the default timeout value is 1 second.
90 For all subsequent timeouts, the default behavior is to double the
91 duration up to a maximum of 1 minute.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 Returns void.
95 .SH HISTORY
96 .IX Header "HISTORY"
97 The \fBDTLS_set_timer_cb()\fR function was added in OpenSSL 1.1.1.
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2017\-2025 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.