diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_read.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_read.3 | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_read.3 b/secure/lib/libcrypto/man/man3/SSL_read.3 index d2e93e2991f7..86adff085dc0 100644 --- a/secure/lib/libcrypto/man/man3/SSL_read.3 +++ b/secure/lib/libcrypto/man/man3/SSL_read.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_READ 3ossl" -.TH SSL_READ 3ossl 2025-09-30 3.5.4 OpenSSL +.TH SSL_READ 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 @@ -91,7 +94,7 @@ In the paragraphs below a "read function" is defined as one of \fBSSL_read_ex()\ .PP If necessary, a read function will negotiate a TLS/SSL session, if not already explicitly performed by \fBSSL_connect\fR\|(3) or \fBSSL_accept\fR\|(3). If the -peer requests a re-negotiation, it will be performed transparently during +peer requests a re\-negotiation, it will be performed transparently during the read function operation. The behaviour of the read functions depends on the underlying BIO. .PP @@ -115,7 +118,7 @@ of the underlying transport (e.g. TCP), it may be necessary to read several packets from the transport layer before the record is complete and the read call can succeed. .PP -If \fBSSL_MODE_AUTO_RETRY\fR has been switched off and a non-application data +If \fBSSL_MODE_AUTO_RETRY\fR has been switched off and a non\-application data record has been processed, the read function can return and set the error to \&\fBSSL_ERROR_WANT_READ\fR. In this case there might still be unprocessed data available in the \fBBIO\fR. @@ -125,9 +128,9 @@ This behaviour can be controlled using the \fBSSL_CTX_set_mode\fR\|(3) call. .PP If the underlying BIO is \fBblocking\fR, a read function will only return once the read operation has been finished or an error occurred, except when a -non-application data record has been processed and \fBSSL_MODE_AUTO_RETRY\fR is +non\-application data record has been processed and \fBSSL_MODE_AUTO_RETRY\fR is not set. -Note that if \fBSSL_MODE_AUTO_RETRY\fR is set and only non-application data is +Note that if \fBSSL_MODE_AUTO_RETRY\fR is set and only non\-application data is available the call will hang. .PP If the underlying BIO is \fBnonblocking\fR, a read function will also return when @@ -136,7 +139,7 @@ operation. In this case a call to \fBSSL_get_error\fR\|(3) with the return value of the read function will yield \fBSSL_ERROR_WANT_READ\fR or \&\fBSSL_ERROR_WANT_WRITE\fR. -As at any time it's possible that non-application data needs to be sent, +As at any time it\*(Aqs possible that non\-application data needs to be sent, a read function can also cause write operations. The calling process then must repeat the call after taking appropriate action to satisfy the needs of the read function. @@ -165,7 +168,7 @@ Success means that 1 or more application data bytes have been read from the SSL connection. Failure means that no bytes could be read from the SSL connection. Failures can be retryable (e.g. we are waiting for more bytes to -be delivered by the network) or non-retryable (e.g. a fatal network error). +be delivered by the network) or non\-retryable (e.g. a fatal network error). In the event of a failure call \fBSSL_get_error\fR\|(3) to find out the reason which indicates whether the call is retryable or not. .PP @@ -183,7 +186,7 @@ Call \fBSSL_get_error\fR\|(3) with the return value \fBret\fR to find out the re .Sp Old documentation indicated a difference between 0 and \-1, and that \-1 was retryable. -You should instead call \fBSSL_get_error()\fR to find out if it's retryable. +You should instead call \fBSSL_get_error()\fR to find out if it\*(Aqs retryable. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBSSL_get_error\fR\|(3), \fBSSL_write_ex\fR\|(3), |