aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.3')
-rw-r--r--secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.317
1 files changed, 10 insertions, 7 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.3 b/secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.3
index 923d493c82b7..ca78e45f3513 100644
--- a/secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.3
+++ b/secure/lib/libcrypto/man/man3/SSL_CTX_set_read_ahead.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_CTX_SET_READ_AHEAD 3ossl"
-.TH SSL_CTX_SET_READ_AHEAD 3ossl 2025-09-30 3.5.4 OpenSSL
+.TH SSL_CTX_SET_READ_AHEAD 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
@@ -102,17 +105,17 @@ These functions have no impact when used with DTLS. The return values for
\&\fBread_ahead\fR can impact the behaviour of the \fBSSL_pending()\fR function
(see \fBSSL_pending\fR\|(3)).
.PP
-Since \fBSSL_read()\fR can return \fBSSL_ERROR_WANT_READ\fR for non-application data
-records, and \fBSSL_has_pending()\fR can't tell the difference between processed and
-unprocessed data, it's recommended that if read ahead is turned on that
+Since \fBSSL_read()\fR can return \fBSSL_ERROR_WANT_READ\fR for non\-application data
+records, and \fBSSL_has_pending()\fR can\*(Aqt tell the difference between processed and
+unprocessed data, it\*(Aqs recommended that if read ahead is turned on that
\&\fBSSL_MODE_AUTO_RETRY\fR is not turned off using \fBSSL_CTX_clear_mode()\fR.
That will prevent getting \fBSSL_ERROR_WANT_READ\fR when there is still a complete
-record available that hasn't been processed.
+record available that hasn\*(Aqt been processed.
.PP
If the application wants to continue to use the underlying transport (e.g. TCP
connection) after the SSL connection is finished using \fBSSL_shutdown()\fR reading
ahead should be turned off.
-Otherwise the SSL structure might read data that it shouldn't.
+Otherwise the SSL structure might read data that it shouldn\*(Aqt.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBSSL_get_read_ahead()\fR and \fBSSL_CTX_get_read_ahead()\fR return 0 if reading ahead is off,