Android_verify/lib/openssl/share/man/man3/DTLSv1_get_timeout.3ossl

.\" -*- 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_GET_TIMEOUT 3ossl"
.TH DTLSV1_GET_TIMEOUT 3ossl 2025-01-17 3.4.0 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_get_timeout \- determine when a DTLS or QUIC SSL object next needs a
timeout event to be handled
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
\& int DTLSv1_get_timeout(SSL *s, struct timeval *tv);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBDTLSv1_get_timeout()\fR can be used on a DTLS or QUIC SSL object to determine when
the SSL object next needs to perform internal processing due to the passage of
time.
.PP
Calling \fBDTLSv1_get_timeout()\fR results in \fI*tv\fR being written with an amount of
time left before the SSL object needs have \fBDTLSv1_handle_timeout()\fR called on it.
If the SSL object needs to be ticked immediately, \fI*tv\fR is zeroed and the
function succeeds, returning 1. If no timeout is currently active, this function
returns 0.
.PP
This function is only applicable to DTLS and QUIC objects. It fails if called on
any other kind of SSL object.
.PP
Note that the value output by a call to \fBDTLSv1_get_timeout()\fR may change as a
result of other calls to the SSL object.
.PP
Once the timeout expires, \fBDTLSv1_handle_timeout()\fR should be called to handle any
internal processing which is due; for more information, see
\&\fBDTLSv1_handle_timeout\fR\|(3).
.PP
\&\fBSSL_get_event_timeout\fR\|(3) supersedes all use cases for this this function and
may be used instead of it.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
On success, writes a duration to \fI*tv\fR and returns 1.
.PP
Returns 0 on failure, or if no timeout is currently active.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBDTLSv1_handle_timeout\fR\|(3), \fBSSL_get_event_timeout\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>.