summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl')
-rw-r--r--upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl105
1 files changed, 105 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl b/upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl
new file mode 100644
index 00000000..a359a3e4
--- /dev/null
+++ b/upstream/debian-unstable/man3/DTLSv1_handle_timeout.3ssl
@@ -0,0 +1,105 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "DTLSV1_HANDLE_TIMEOUT 3SSL"
+.TH DTLSV1_HANDLE_TIMEOUT 3SSL 2024-04-04 3.2.2-dev OpenSSL
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+DTLSv1_handle_timeout \- handle a pending timeout event for a DTLS or QUIC SSL
+object
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/ssl.h>
+\&
+\& int DTLSv1_handle_timeout(SSL *ssl);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBDTLSv1_handle_timeout()\fR handles any timeout events which have become pending
+on a DTLS or QUIC SSL object.
+.PP
+Use \fBDTLSv1_get_timeout\fR\|(3) or \fBSSL_get_event_timeout\fR\|(3) to determine
+when to call \fBDTLSv1_handle_timeout()\fR.
+.PP
+This function is only applicable to DTLS or QUIC SSL objects. It returns 0 if
+called on any other kind of SSL object.
+.PP
+\&\fBSSL_handle_events\fR\|(3) supersedes all use cases for this function and may
+be used instead of it.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+Returns 1 if there was a pending timeout event and it was handled successfully.
+.PP
+Returns 0 if there was no pending timeout event, or if the SSL object is not a
+DTLS or QUIC object.
+.PP
+Returns \-1 if there was a pending timeout event but it could not be handled
+successfully.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBDTLSv1_get_timeout\fR\|(3), \fBSSL_handle_events\fR\|(3), \fBssl\fR\|(7)
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+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
+<https://www.openssl.org/source/license.html>.