aboutsummaryrefslogtreecommitdiff
path: root/crypto/openssl/doc/man3/DTLS_set_timer_cb.pod
blob: 618fd1f6ff0e9c3838e9a2550ea987840f6f1969 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
=pod

=head1 NAME

DTLS_timer_cb,
DTLS_set_timer_cb
- Set callback for controlling DTLS timer duration

=head1 SYNOPSIS

 #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);

=head1 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 I<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.

=head1 RETURN VALUES

Returns void.

=head1 HISTORY

The DTLS_set_timer_cb() function was added in OpenSSL 1.1.1.

=head1 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
L<https://www.openssl.org/source/license.html>.

=cut