SSL_want - SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, obtain state information TLS/SSL I/O operation
#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);
SSL_want(3openssl) OpenSSL SSL_want(3openssl)
NAME
SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write,
SSL_want_x509_lookup - obtain state information TLS/SSL I/O operation
SYNOPSIS
#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);
DESCRIPTION
SSL_want() returns state information for the SSL object ssl.
The other SSL_want_*() calls are shortcuts for the possible states
returned by SSL_want().
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | library/security/openssl |
+---------------+--------------------------+
|Stability | Pass-through uncommitted |
+---------------+--------------------------+
NOTES
SSL_want() examines the internal state information of the SSL 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 non-blocking 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).
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.
Further information about this software can be found on the open source
community website at https://www.openssl.org/.
RETURN VALUES
The following return values can currently occur for SSL_want():
SSL_NOTHING
There is no data to be written or to be read.
SSL_WRITING
There are data in the SSL buffer that must be written to the
underlying BIO layer in order to complete the actual SSL_*()
operation. A call to SSL_get_error(3) should return
SSL_ERROR_WANT_WRITE.
SSL_READING
More data must be read from the underlying BIO layer in order to
complete the actual SSL_*() operation. A call to SSL_get_error(3)
should return SSL_ERROR_WANT_READ.
SSL_X509_LOOKUP
The operation did not complete because an application callback set
by SSL_CTX_set_client_cert_cb() has asked to be called again. A
call to SSL_get_error(3) should return SSL_ERROR_WANT_X509_LOOKUP.
SSL_want_nothing(), SSL_want_read(), SSL_want_write(),
SSL_want_x509_lookup() return 1, when the corresponding condition is
true or 0 otherwise.
SEE ALSO
ssl(3), err(3), SSL_get_error(3)
1.0.2ze 2022-05-03 SSL_want(3openssl)