OpenGrok

$NetBSD: SSL_want.3,v 1.26 2025/04/16 15:23:16 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "SSL_want 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
.nh 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 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 Header "DESCRIPTION" \fBSSL_want() returns state information for the SSL object ssl.

The other SSL_want_*() calls are shortcuts for the possible states returned by SSL_want().

Header "NOTES" \fBSSL_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 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).

Header "RETURN VALUES" The following return values can currently occur for SSL_want(): Item "SSL_NOTHING" There is no data to be written or to be read. Item "SSL_WRITING" There are data in the SSL buffer that must be written to the underlying \fBBIO layer in order to complete the actual SSL_*() operation. A call to SSL_get_error\|(3) should return SSL_ERROR_WANT_WRITE. Item "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. 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 SSL_ERROR_WANT_X509_LOOKUP. 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 SSL_ERROR_WANT_RETRY_VERIFY. 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 \fBSSL_ERROR_WANT_ASYNC. 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 SSL_ERROR_WANT_ASYNC_JOB. 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 SSL_ERROR_WANT_CLIENT_HELLO_CB.

\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.

Header "SEE ALSO" \fBssl\|(7), SSL_get_error\|(3) Header "HISTORY" The SSL_want_client_hello_cb() function and the SSL_CLIENT_HELLO_CB return value were added in OpenSSL 1.1.1. Header "COPYRIGHT" Copyright 2001-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

Indexes created Fri Apr 24 00:22:58 UTC 2026