aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/SSL_poll.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_poll.3')
-rw-r--r--secure/lib/libcrypto/man/man3/SSL_poll.325
1 files changed, 14 insertions, 11 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_poll.3 b/secure/lib/libcrypto/man/man3/SSL_poll.3
index 95ba9d818ef9..6dda229bf65f 100644
--- a/secure/lib/libcrypto/man/man3/SSL_poll.3
+++ b/secure/lib/libcrypto/man/man3/SSL_poll.3
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
-.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,10 +52,13 @@
. \}
.\}
.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "SSL_POLL 3ossl"
-.TH SSL_POLL 3ossl 2025-09-30 3.5.4 OpenSSL
+.TH SSL_POLL 3ossl 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
@@ -172,7 +175,7 @@ actually applicable to the resource described by \fIdesc\fR. As for \fIevents\fR
it is a collection of zero or more \fBSSL_POLL_EVENT\fR flags.
.Sp
\&\fIrevents\fR need not be a subset of the events specified in \fIevents\fR, as some
-event types are defined as always being enabled (non-maskable). See "EVENT
+event types are defined as always being enabled (non\-maskable). See "EVENT
TYPES" for more information.
.PP
To use \fBSSL_poll()\fR, call it with an array of \fBSSL_POLL_ITEM\fR structures. The
@@ -186,11 +189,11 @@ to use \fBSSL_poll()\fR in blocking or nonblocking mode:
If \fItimeout\fR is NULL, the function blocks indefinitely until at least one
resource is ready.
.IP \(bu 4
-If \fItimeout\fR is non-NULL, and it points to a \fBstruct timeval\fR which is set to
+If \fItimeout\fR is non\-NULL, and it points to a \fBstruct timeval\fR which is set to
zero, the function operates in nonblocking mode and returns immediately with
readiness information.
.IP \(bu 4
-If \fItimeout\fR is non-NULL, and it points to a \fBstruct timeval\fR which is set to
+If \fItimeout\fR is non\-NULL, and it points to a \fBstruct timeval\fR which is set to
a value other than zero, the function blocks for the specified interval or until
at least one of the specified resources is ready, whichever comes first.
.PP
@@ -210,7 +213,7 @@ state machine processing is performed.
If this flag is used in blocking mode (for example, with \fItimeout\fR set to
NULL), event processing does not occur unless the function blocks.
.PP
-The \fIresult_count\fR argument is optional. If it is non-NULL, it is used to
+The \fIresult_count\fR argument is optional. If it is non\-NULL, it is used to
output the number of entries in the array which have nonzero \fIrevents\fR fields
when the call to \fBSSL_poll()\fR returns; see "RETURN VALUES" for details.
.SH "EVENT TYPES"
@@ -228,7 +231,7 @@ repeated notifications and has not caused the underlying readiness condition
\&\fBSSL_POLL_EVENT_R\fR is reported) to be deasserted.
.PP
Some event types do not make sense on a given kind of resource. In this case,
-specifying that event type in \fIevents\fR is a no-op and will be ignored, and the
+specifying that event type in \fIevents\fR is a no\-op and will be ignored, and the
given event will never be reported in \fIrevents\fR.
.PP
Failure of the polling mechanism itself is considered distinct from an exception
@@ -237,10 +240,10 @@ and "RETURN VALUES" for details.
.PP
In general, an application should always listen for the event types
corresponding to exception conditions if it is listening to the corresponding
-non-exception event types (e.g. \fBSSL_POLL_EVENT_EC\fR and \fBSSL_POLL_EVENT_ER\fR
+non\-exception event types (e.g. \fBSSL_POLL_EVENT_EC\fR and \fBSSL_POLL_EVENT_ER\fR
for \fBSSL_POLL_EVENT_R\fR), as not doing so is unlikely to be a sound design.
.PP
-Some event types are non-maskable and may be reported in \fIrevents\fR regardless
+Some event types are non\-maskable and may be reported in \fIrevents\fR regardless
of whether they were requested in \fIevents\fR.
.PP
The following event types are supported:
@@ -306,7 +309,7 @@ Writable. This event is raised when a QUIC stream SSL object (or a QUIC
connection SSL object with a default stream attached) could accept more
application data using \fBSSL_write_ex\fR\|(3).
.Sp
-This event is never raised by a receive-only stream.
+This event is never raised by a receive\-only stream.
.Sp
This event is never raised by a stream which has had its send part concluded
normally (as with \fBSSL_stream_conclude\fR\|(3)) or locally reset (as with
@@ -356,7 +359,7 @@ Unless the \fIitems\fR pointer itself is invalid, \fBSSL_poll()\fR will always i
the \fIrevents\fR fields of all items in the input array upon returning, even if it
returns failure.
.PP
-If \fIresult_count\fR is non-NULL, it is always written with the number of items in
+If \fIresult_count\fR is non\-NULL, it is always written with the number of items in
the array with nonzero \fIrevents\fR fields, even if the \fBSSL_poll()\fR call returns
failure.
.PP