SSL_want.3 revision 1.4.4.1.4.7 $NetBSD: SSL_want.3,v 1.4.4.1.4.7 2016/03/09 00:34:32 snj Exp $ 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_want 3" SSL_want 3 "2009-07-19" "1.0.1s" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
"NAME"
SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup - obtain state information
TLS/
SSL I/O operation
"LIBRARY"
libcrypto, -lcrypto
"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);
.Ve
"DESCRIPTION"
Header "DESCRIPTION" \fISSL_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" \fISSL_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
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).
"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
\fISSL_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
\fISSL_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"
Header "SEE ALSO" \fIssl\|(3),
openssl_err\|(3),
SSL_get_error\|(3)