Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
Standard preamble:
========================================================================
..
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "SSL_WANT 3"
way too many mistakes in technical documents.
Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "SSL_WANT 3"
SSL_WANT 3 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
"NAME"
SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write,
SSL_want_x509_lookup, SSL_want_retry_verify, SSL_want_async, SSL_want_async_job,
SSL_want_client_hello_cb - obtain state information TLS/SSL I/O operation
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1
#include <openssl/ssl.h>
\&
int SSL_want(const SSL *ssl);
int SSL_want_nothing(const SSL *ssl);
int SSL_want_read(const SSL *ssl);
int SSL_want_write(const SSL *ssl);
int SSL_want_x509_lookup(const SSL *ssl);
int SSL_want_retry_verify(const SSL *ssl);
int SSL_want_async(const SSL *ssl);
int SSL_want_async_job(const SSL *ssl);
int SSL_want_client_hello_cb(const SSL *ssl);
.Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBSSL_want() returns state information for the \s-1SSL\s0 object ssl.
The other SSL_want_*() calls are shortcuts for the possible states returned by SSL_want().
"NOTES"
Header "NOTES" \fBSSL_want() examines the internal state information of the \s-1SSL\s0 object. Its
return values are similar to that of SSL_get_error\|(3).
Unlike SSL_get_error\|(3), which also evaluates the
error queue, the results are obtained by examining an internal state flag
only. The information must therefore only be used for normal operation under
nonblocking I/O. Error conditions are not handled and must be treated
using SSL_get_error\|(3).
The result returned by SSL_want() should always be consistent with the result of SSL_get_error\|(3).
"RETURN VALUES"
Header "RETURN VALUES" The following return values can currently occur for SSL_want():
"\s-1SSL_NOTHING\s0" 4
Item "SSL_NOTHING" There is no data to be written or to be read.
"\s-1SSL_WRITING\s0" 4
Item "SSL_WRITING" There are data in the \s-1SSL\s0 buffer that must be written to the underlying
\fB\s-1BIO\s0 layer in order to complete the actual SSL_*() operation.
A call to SSL_get_error\|(3) should return \s-1SSL_ERROR_WANT_WRITE\s0.
"\s-1SSL_READING\s0" 4
Item "SSL_READING" More data must be read from the underlying \s-1BIO\s0 layer in order to
complete the actual SSL_*() operation.
A call to SSL_get_error\|(3) should return \s-1SSL_ERROR_WANT_READ\s0.
"\s-1SSL_X509_LOOKUP\s0" 4
Item "SSL_X509_LOOKUP" The operation did not complete because an application callback set by
\fBSSL_CTX_set_client_cert_cb() has asked to be called again.
A call to SSL_get_error\|(3) should return \s-1SSL_ERROR_WANT_X509_LOOKUP\s0.
"\s-1SSL_RETRY_VERIFY\s0" 4
Item "SSL_RETRY_VERIFY" The operation did not complete because a certificate verification callback
has asked to be called again via SSL_set_retry_verify\|(3).
A call to SSL_get_error\|(3) should return \s-1SSL_ERROR_WANT_RETRY_VERIFY\s0.
"\s-1SSL_ASYNC_PAUSED\s0" 4
Item "SSL_ASYNC_PAUSED" An asynchronous operation partially completed and was then paused. See
\fBSSL_get_all_async_fds\|(3). A call to SSL_get_error\|(3) should return
\fB\s-1SSL_ERROR_WANT_ASYNC\s0.
"\s-1SSL_ASYNC_NO_JOBS\s0" 4
Item "SSL_ASYNC_NO_JOBS" The asynchronous job could not be started because there were no async jobs
available in the pool (see ASYNC_init_thread\|(3)). A call to SSL_get_error\|(3)
should return \s-1SSL_ERROR_WANT_ASYNC_JOB\s0.
"\s-1SSL_CLIENT_HELLO_CB\s0" 4
Item "SSL_CLIENT_HELLO_CB" The operation did not complete because an application callback set by
\fBSSL_CTX_set_client_hello_cb() has asked to be called again.
A call to SSL_get_error\|(3) should return \s-1SSL_ERROR_WANT_CLIENT_HELLO_CB\s0.
\fBSSL_want_nothing(), SSL_want_read(), SSL_want_write(), \fBSSL_want_x509_lookup(), SSL_want_retry_verify(), \fBSSL_want_async(), SSL_want_async_job(), and SSL_want_client_hello_cb() return 1 when the corresponding condition is true or 0 otherwise.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), SSL_get_error\|(3)
"HISTORY"
Header "HISTORY" The SSL_want_client_hello_cb() function and the \s-1SSL_CLIENT_HELLO_CB\s0 return value
were added in OpenSSL 1.1.1.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2001-2022 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.