1=pod
2
3=head1 NAME
4
5DTLSv1_handle_timeout - handle a pending timeout event for a DTLS or QUIC SSL
6object
7
8=head1 SYNOPSIS
9
10 #include <openssl/ssl.h>
11
12 int DTLSv1_handle_timeout(SSL *ssl);
13
14=head1 DESCRIPTION
15
16DTLSv1_handle_timeout() handles any timeout events which have become pending
17on a DTLS or QUIC SSL object.
18
19Use L<DTLSv1_get_timeout(3)> or L<SSL_get_event_timeout(3)> to determine
20when to call DTLSv1_handle_timeout().
21
22This function is only applicable to DTLS or QUIC SSL objects. It returns 0 if
23called on any other kind of SSL object.
24
25L<SSL_handle_events(3)> supersedes all use cases for this function and may
26be used instead of it.
27
28=head1 RETURN VALUES
29
30Returns 1 if there was a pending timeout event and it was handled successfully.
31
32Returns 0 if there was no pending timeout event, or if the SSL object is not a
33DTLS or QUIC object.
34
35Returns -1 if there was a pending timeout event but it could not be handled
36successfully.
37
38=head1 SEE ALSO
39
40L<DTLSv1_get_timeout(3)>, L<SSL_handle_events(3)>, L<ssl(7)>
41
42=head1 COPYRIGHT
43
44Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.
45
46Licensed under the Apache License 2.0 (the "License").  You may not use
47this file except in compliance with the License.  You can obtain a copy
48in the file LICENSE in the source distribution or at
49L<https://www.openssl.org/source/license.html>.
50
51=cut
52