add callback handler for setting DTLS timer interval
[openssl.git] / doc / man3 / DTLS_set_timer_cb.pod
1 =pod
2
3 =head1 NAME
4
5 DTLS_timer_cb,
6 DTLS_set_timer_cb
7 - Set callback for controlling DTLS timer duration
8
9 =head1 SYNOPSIS
10
11  #include <openssl/ssl.h>
12
13  typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
14
15  void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
16
17 =head1 DESCRIPTION
18
19 This function sets an optional callback function for controlling the
20 timeout interval on the DTLS protocol. The callback function will be
21 called by DTLS for every new DTLS packet that is sent.
22
23 =head1 RETURN VALUES
24
25 Returns void.
26
27 =head1 HISTORY
28
29 This function was added in OpenSSL 1.1.1
30
31 =head1 COPYRIGHT
32
33 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
34
35 Licensed under the OpenSSL license (the "License").  You may not use
36 this file except in compliance with the License.  You can obtain a copy
37 in the file LICENSE in the source distribution or at
38 L<https://www.openssl.org/source/license.html>.
39
40 =cut