diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
| commit | 253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch) | |
| tree | adf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/SSL_get_event_timeout.3 | |
| parent | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff) | |
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/SSL_get_event_timeout.3')
| -rw-r--r-- | static/netbsd/man3/SSL_get_event_timeout.3 | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/static/netbsd/man3/SSL_get_event_timeout.3 b/static/netbsd/man3/SSL_get_event_timeout.3 new file mode 100644 index 00000000..56302dc9 --- /dev/null +++ b/static/netbsd/man3/SSL_get_event_timeout.3 @@ -0,0 +1,136 @@ +.\" $NetBSD: SSL_get_event_timeout.3,v 1.5 2026/04/08 17:06:48 christos Exp $ +.\" +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" 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 +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "SSL_get_event_timeout 3" +.TH SSL_get_event_timeout 3 2026-04-07 3.5.6 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 +SSL_get_event_timeout \- determine when an SSL object next needs to have events +handled +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& int SSL_get_event_timeout(SSL *s, struct timeval *tv, int *is_infinite); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_get_event_timeout()\fR determines when the SSL object next needs to perform +internal processing due to the passage of time. +.PP +All arguments are required; \fItv\fR and \fIis_infinite\fR must be non\-NULL. +.PP +Upon the successful return of \fBSSL_get_event_timeout()\fR, one of the following +cases applies: +.IP \(bu 4 +The SSL object has events which need to be handled immediately; The fields of +\&\fI*tv\fR are set to 0 and \fI*is_infinite\fR is set to 0. +.IP \(bu 4 +The SSL object has events which need to be handled after some amount of time +(relative to the time at which \fBSSL_get_event_timeout()\fR was called). \fI*tv\fR is +set to the amount of time after which \fBSSL_handle_events\fR\|(3) should be called +and \fI*is_infinite\fR is set to 0. +.IP \(bu 4 +There are currently no timer events which require handling in the future. The +value of \fI*tv\fR is unspecified and \fI*is_infinite\fR is set to 1. +.PP +This function is currently applicable only to DTLS and QUIC connection SSL +objects. If it is called on any other kind of SSL object, it always outputs +infinity. This is considered a success condition. +.PP +For DTLS, this function can be used instead of the older +\&\fBDTLSv1_get_timeout\fR\|(3) function. Note that this function differs from +\&\fBDTLSv1_get_timeout\fR\|(3) in that the case where no timeout is active is +considered a success condition. +.PP +Note that the value output by a call to \fBSSL_get_event_timeout()\fR may change as a +result of other calls to the SSL object. +.PP +Once the timeout expires, \fBSSL_handle_events\fR\|(3) should be called to handle any +internal processing which is due; for more information, see +\&\fBSSL_handle_events\fR\|(3). +.PP +Note that \fBSSL_get_event_timeout()\fR supersedes the older \fBDTLSv1_get_timeout\fR\|(3) +function for all use cases. +.PP +If the call to \fBSSL_get_event_timeout()\fR fails, the values of \fI*tv\fR and +\&\fI*is_infinite\fR may still be changed and their values become unspecified. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +Returns 1 on success and 0 on failure. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBSSL_handle_events\fR\|(3), \fBDTLSv1_get_timeout\fR\|(3), \fBssl\fR\|(7) +.SH HISTORY +.IX Header "HISTORY" +The \fBSSL_get_event_timeout()\fR function was added in OpenSSL 3.2. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2022\-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>. |
