1SSL_want(3)                         OpenSSL                        SSL_want(3)
2
3
4

NAME

6       SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write,
7       SSL_want_x509_lookup - obtain state information TLS/SSL I/O operation
8

SYNOPSIS

10        #include <openssl/ssl.h>
11
12        int SSL_want(const SSL *ssl);
13        int SSL_want_nothing(const SSL *ssl);
14        int SSL_want_read(const SSL *ssl);
15        int SSL_want_write(const SSL *ssl);
16        int SSL_want_x509_lookup(const SSL *ssl);
17

DESCRIPTION

19       SSL_want() returns state information for the SSL object ssl.
20
21       The other SSL_want_*() calls are shortcuts for the possible states
22       returned by SSL_want().
23

NOTES

25       SSL_want() examines the internal state information of the SSL object.
26       Its return values are similar to that of SSL_get_error(3).  Unlike
27       SSL_get_error(3), which also evaluates the error queue, the results are
28       obtained by examining an internal state flag only. The information must
29       therefore only be used for normal operation under non-blocking I/O.
30       Error conditions are not handled and must be treated using
31       SSL_get_error(3).
32
33       The result returned by SSL_want() should always be consistent with the
34       result of SSL_get_error(3).
35

RETURN VALUES

37       The following return values can currently occur for SSL_want():
38
39       SSL_NOTHING
40           There is no data to be written or to be read.
41
42       SSL_WRITING
43           There are data in the SSL buffer that must be written to the
44           underlying BIO layer in order to complete the actual SSL_*()
45           operation.  A call to SSL_get_error(3) should return
46           SSL_ERROR_WANT_WRITE.
47
48       SSL_READING
49           More data must be read from the underlying BIO layer in order to
50           complete the actual SSL_*() operation.  A call to SSL_get_error(3)
51           should return SSL_ERROR_WANT_READ.
52
53       SSL_X509_LOOKUP
54           The operation did not complete because an application callback set
55           by SSL_CTX_set_client_cert_cb() has asked to be called again.  A
56           call to SSL_get_error(3) should return SSL_ERROR_WANT_X509_LOOKUP.
57
58       SSL_want_nothing(), SSL_want_read(), SSL_want_write(),
59       SSL_want_x509_lookup() return 1, when the corresponding condition is
60       true or 0 otherwise.
61

SEE ALSO

63       ssl(3), err(3), SSL_get_error(3)
64
65
66
671.0.2o                            2020-08-01                       SSL_want(3)
Impressum