Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libssl / man / SSL_want.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
e056f0e0
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
e056f0e0 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
e056f0e0 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
e056f0e0 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
e056f0e0
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
e056f0e0 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
e056f0e0
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
e056f0e0
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
e056f0e0
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
e056f0e0
JR
59. nr % 0
60. rr F
984263bc 61.\}
e056f0e0 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
e056f0e0
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
e056f0e0
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
e056f0e0
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
e056f0e0 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
e056f0e0
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
e056f0e0
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
e056f0e0 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
e056f0e0 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
e056f0e0 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
e056f0e0
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
e056f0e0
JR
129.\" ========================================================================
130.\"
131.IX Title "SSL_want 3"
18ed9402 132.TH SSL_want 3 "2008-09-27" "0.9.8i" "OpenSSL"
984263bc 133.SH "NAME"
a7d27d5a 134SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup \- obtain state information TLS/SSL I/O operation
984263bc 135.SH "SYNOPSIS"
e056f0e0 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/ssl.h>
aac4ff6f
PA
139.Ve
140.PP
141.Vb 5
a561f9ff
SS
142\& int SSL_want(const SSL *ssl);
143\& int SSL_want_nothing(const SSL *ssl);
144\& int SSL_want_read(const SSL *ssl);
145\& int SSL_want_write(const SSL *ssl);
146\& int SSL_want_x509_lookup(const SSL *ssl);
984263bc
MD
147.Ve
148.SH "DESCRIPTION"
e056f0e0
JR
149.IX Header "DESCRIPTION"
150\&\fISSL_want()\fR returns state information for the \s-1SSL\s0 object \fBssl\fR.
984263bc
MD
151.PP
152The other SSL_want_*() calls are shortcuts for the possible states returned
153by \fISSL_want()\fR.
154.SH "NOTES"
e056f0e0
JR
155.IX Header "NOTES"
156\&\fISSL_want()\fR examines the internal state information of the \s-1SSL\s0 object. Its
157return values are similar to that of \fISSL_get_error\fR\|(3).
158Unlike \fISSL_get_error\fR\|(3), which also evaluates the
984263bc
MD
159error queue, the results are obtained by examining an internal state flag
160only. The information must therefore only be used for normal operation under
161non-blocking I/O. Error conditions are not handled and must be treated
e056f0e0 162using \fISSL_get_error\fR\|(3).
984263bc
MD
163.PP
164The result returned by \fISSL_want()\fR should always be consistent with
e056f0e0 165the result of \fISSL_get_error\fR\|(3).
984263bc 166.SH "RETURN VALUES"
e056f0e0 167.IX Header "RETURN VALUES"
984263bc 168The following return values can currently occur for \fISSL_want()\fR:
e056f0e0
JR
169.IP "\s-1SSL_NOTHING\s0" 4
170.IX Item "SSL_NOTHING"
984263bc 171There is no data to be written or to be read.
e056f0e0
JR
172.IP "\s-1SSL_WRITING\s0" 4
173.IX Item "SSL_WRITING"
984263bc 174There are data in the \s-1SSL\s0 buffer that must be written to the underlying
e056f0e0
JR
175\&\fB\s-1BIO\s0\fR layer in order to complete the actual SSL_*() operation.
176A call to \fISSL_get_error\fR\|(3) should return
177\&\s-1SSL_ERROR_WANT_WRITE\s0.
178.IP "\s-1SSL_READING\s0" 4
179.IX Item "SSL_READING"
984263bc 180More data must be read from the underlying \fB\s-1BIO\s0\fR layer in order to
e056f0e0
JR
181complete the actual SSL_*() operation.
182A call to \fISSL_get_error\fR\|(3) should return
183\&\s-1SSL_ERROR_WANT_READ\s0.
184.IP "\s-1SSL_X509_LOOKUP\s0" 4
185.IX Item "SSL_X509_LOOKUP"
984263bc 186The operation did not complete because an application callback set by
e056f0e0
JR
187\&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
188A call to \fISSL_get_error\fR\|(3) should return
189\&\s-1SSL_ERROR_WANT_X509_LOOKUP\s0.
984263bc 190.PP
e056f0e0 191\&\fISSL_want_nothing()\fR, \fISSL_want_read()\fR, \fISSL_want_write()\fR, \fISSL_want_x509_lookup()\fR
984263bc
MD
192return 1, when the corresponding condition is true or 0 otherwise.
193.SH "SEE ALSO"
a7d27d5a 194.IX Header "SEE ALSO"
e056f0e0 195\&\fIssl\fR\|(3), \fIerr\fR\|(3), \fISSL_get_error\fR\|(3)