Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

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 turned on, 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_get_error 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_get_error - obtain result code for TLS/SSL I/O operation Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& int SSL_get_error(const SSL *ssl, int ret); .Ve Header "DESCRIPTION" \fISSL_get_error() returns a result code (suitable for the C \*(L"switch\*(R" statement) for a preceding call to SSL_connect(), SSL_accept(), SSL_do_handshake(), \fISSL_read(), SSL_peek(), or SSL_write() on ssl. The value returned by that \s-1TLS/SSL I/O\s0 function must be passed to SSL_get_error() in parameter \fBret.

In addition to ssl and ret, SSL_get_error() inspects the current thread's OpenSSL error queue. Thus, SSL_get_error() must be used in the same thread that performed the \s-1TLS/SSL I/O\s0 operation, and no other OpenSSL function calls should appear in between. The current thread's error queue must be empty before the \s-1TLS/SSL I/O\s0 operation is attempted, or SSL_get_error() will not work reliably.

Header "RETURN VALUES" The following return values can currently occur: Item "SSL_ERROR_NONE" The \s-1TLS/SSL I/O\s0 operation completed. This result code is returned if and only if ret > 0. Item "SSL_ERROR_ZERO_RETURN" The \s-1TLS/SSL\s0 connection has been closed. If the protocol version is \s-1SSL 3.0\s0 or \s-1TLS 1.0,\s0 this result code is returned only if a closure alert has occurred in the protocol, i.e. if the connection has been closed cleanly. Note that in this case \s-1SSL_ERROR_ZERO_RETURN\s0 does not necessarily indicate that the underlying transport has been closed. Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE" The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be called again later. If, by then, the underlying \s-1BIO\s0 has data available for reading (if the result code is \s-1SSL_ERROR_WANT_READ\s0) or allows writing data (\s-1SSL_ERROR_WANT_WRITE\s0), then some \s-1TLS/SSL\s0 protocol progress will take place, i.e. at least part of an \s-1TLS/SSL\s0 record will be read or written. Note that the retry may again lead to a \s-1SSL_ERROR_WANT_READ\s0 or \s-1SSL_ERROR_WANT_WRITE\s0 condition. There is no fixed upper limit for the number of iterations that may be necessary until progress becomes visible at application protocol level. .Sp For socket \s-1BIO\s0s (e.g. when SSL_set_fd() was used), select() or \fIpoll() on the underlying socket can be used to find out when the \s-1TLS/SSL I/O\s0 function should be retried. .Sp Caveat: Any \s-1TLS/SSL I/O\s0 function can lead to either of \fB\s-1SSL_ERROR_WANT_READ\s0 and \s-1SSL_ERROR_WANT_WRITE\s0. In particular, \fISSL_read() or SSL_peek() may want to write data and SSL_write() may want to read data. This is mainly because \s-1TLS/SSL\s0 handshakes may occur at any time during the protocol (initiated by either the client or the server); \fISSL_read(), SSL_peek(), and SSL_write() will handle any pending handshakes. Item "SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT" The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be called again later. The underlying \s-1BIO\s0 was not connected yet to the peer and the call would block in connect()/accept(). The \s-1SSL\s0 function should be called again when the connection is established. These messages can only appear with a BIO_s_connect() or BIO_s_accept() \s-1BIO,\s0 respectively. In order to find out, when the connection has been successfully established, on many platforms select() or poll() for writing on the socket file descriptor can be used. Item "SSL_ERROR_WANT_X509_LOOKUP" The operation did not complete because an application callback set by \fISSL_CTX_set_client_cert_cb() has asked to be called again. The \s-1TLS/SSL I/O\s0 function should be called again later. Details depend on the application. Item "SSL_ERROR_SYSCALL" Some I/O error occurred. The OpenSSL error queue may contain more information on the error. If the error queue is empty (i.e. ERR_get_error() returns 0), ret can be used to find out more about the error: If ret == 0, an \s-1EOF\s0 was observed that violates the protocol. If ret == -1, the underlying \s-1BIO\s0 reported an I/O error (for socket I/O on Unix systems, consult errno for details). Item "SSL_ERROR_SSL" A failure in the \s-1SSL\s0 library occurred, usually a protocol error. The OpenSSL error queue contains more information on the error. Header "SEE ALSO" \fIssl\|(3), err\|(3) Header "HISTORY" \fISSL_get_error() was added in SSLeay 0.8.