Debian Codegraph @

upstream/debian-unstable/man3/DTLSv1_handle_timeout.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 "DTLSV1_HANDLE_TIMEOUT 3SSL"
58 .TH DTLSV1_HANDLE_TIMEOUT 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 DTLSv1_handle_timeout \- handle a pending timeout event for a DTLS or QUIC SSL
65 object
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& int DTLSv1_handle_timeout(SSL *ssl);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBDTLSv1_handle_timeout()\fR handles any timeout events which have become pending
76 on a DTLS or QUIC SSL object.
77 .PP
78 Use \fBDTLSv1_get_timeout\fR\|(3) or \fBSSL_get_event_timeout\fR\|(3) to determine
79 when to call \fBDTLSv1_handle_timeout()\fR.
80 .PP
81 This function is only applicable to DTLS or QUIC SSL objects. It returns 0 if
82 called on any other kind of SSL object.
83 .PP
84 \&\fBSSL_handle_events\fR\|(3) supersedes all use cases for this function and may
85 be used instead of it.
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 Returns 1 if there was a pending timeout event and it was handled successfully.
89 .PP
90 Returns 0 if there was no pending timeout event, or if the SSL object is not a
91 DTLS or QUIC object.
92 .PP
93 Returns \-1 if there was a pending timeout event but it could not be handled
94 successfully.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBDTLSv1_get_timeout\fR\|(3), \fBSSL_handle_events\fR\|(3), \fBssl\fR\|(7)
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2023 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>.