Merge from vendor branch OPENSSH:
[dragonfly.git] / secure / lib / libcrypto / man / BIO_should_retry.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
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"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
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 .\"
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
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
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'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
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
112 .    \" corrections for vroff
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'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
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
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "BIO_should_retry 3"
132 .TH BIO_should_retry 3 "2008-09-27" "0.9.8i" "OpenSSL"
133 .SH "NAME"
134 BIO_should_retry, BIO_should_read, BIO_should_write,
135 BIO_should_io_special, BIO_retry_type, BIO_should_retry,
136 BIO_get_retry_BIO, BIO_get_retry_reason \- BIO retry functions
137 .SH "SYNOPSIS"
138 .IX Header "SYNOPSIS"
139 .Vb 1
140 \& #include <openssl/bio.h>
141 .Ve
142 .PP
143 .Vb 5
144 \& #define BIO_should_read(a)             ((a)->flags & BIO_FLAGS_READ)
145 \& #define BIO_should_write(a)            ((a)->flags & BIO_FLAGS_WRITE)
146 \& #define BIO_should_io_special(a)       ((a)->flags & BIO_FLAGS_IO_SPECIAL)
147 \& #define BIO_retry_type(a)              ((a)->flags & BIO_FLAGS_RWS)
148 \& #define BIO_should_retry(a)            ((a)->flags & BIO_FLAGS_SHOULD_RETRY)
149 .Ve
150 .PP
151 .Vb 5
152 \& #define BIO_FLAGS_READ         0x01
153 \& #define BIO_FLAGS_WRITE        0x02
154 \& #define BIO_FLAGS_IO_SPECIAL   0x04
155 \& #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
156 \& #define BIO_FLAGS_SHOULD_RETRY 0x08
157 .Ve
158 .PP
159 .Vb 2
160 \& BIO *  BIO_get_retry_BIO(BIO *bio, int *reason);
161 \& int    BIO_get_retry_reason(BIO *bio);
162 .Ve
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 These functions determine why a \s-1BIO\s0 is not able to read or write data.
166 They will typically be called after a failed \fIBIO_read()\fR or \fIBIO_write()\fR
167 call.
168 .PP
169 \&\fIBIO_should_retry()\fR is true if the call that produced this condition
170 should then be retried at a later time.
171 .PP
172 If \fIBIO_should_retry()\fR is false then the cause is an error condition.
173 .PP
174 \&\fIBIO_should_read()\fR is true if the cause of the condition is that a \s-1BIO\s0
175 needs to read data.
176 .PP
177 \&\fIBIO_should_write()\fR is true if the cause of the condition is that a \s-1BIO\s0
178 needs to read data.
179 .PP
180 \&\fIBIO_should_io_special()\fR is true if some \*(L"special\*(R" condition, that is a
181 reason other than reading or writing is the cause of the condition.
182 .PP
183 \&\fIBIO_get_retry_reason()\fR returns a mask of the cause of a retry condition
184 consisting of the values \fB\s-1BIO_FLAGS_READ\s0\fR, \fB\s-1BIO_FLAGS_WRITE\s0\fR,
185 \&\fB\s-1BIO_FLAGS_IO_SPECIAL\s0\fR though current \s-1BIO\s0 types will only set one of
186 these.
187 .PP
188 \&\fIBIO_get_retry_BIO()\fR determines the precise reason for the special
189 condition, it returns the \s-1BIO\s0 that caused this condition and if 
190 \&\fBreason\fR is not \s-1NULL\s0 it contains the reason code. The meaning of
191 the reason code and the action that should be taken depends on
192 the type of \s-1BIO\s0 that resulted in this condition.
193 .PP
194 \&\fIBIO_get_retry_reason()\fR returns the reason for a special condition if
195 passed the relevant \s-1BIO\s0, for example as returned by \fIBIO_get_retry_BIO()\fR.
196 .SH "NOTES"
197 .IX Header "NOTES"
198 If \fIBIO_should_retry()\fR returns false then the precise \*(L"error condition\*(R"
199 depends on the \s-1BIO\s0 type that caused it and the return code of the \s-1BIO\s0
200 operation. For example if a call to \fIBIO_read()\fR on a socket \s-1BIO\s0 returns
201 0 and \fIBIO_should_retry()\fR is false then the cause will be that the
202 connection closed. A similar condition on a file \s-1BIO\s0 will mean that it
203 has reached \s-1EOF\s0. Some \s-1BIO\s0 types may place additional information on
204 the error queue. For more details see the individual \s-1BIO\s0 type manual
205 pages.
206 .PP
207 If the underlying I/O structure is in a blocking mode almost all current
208 \&\s-1BIO\s0 types will not request a retry, because the underlying I/O
209 calls will not. If the application knows that the \s-1BIO\s0 type will never
210 signal a retry then it need not call \fIBIO_should_retry()\fR after a failed
211 \&\s-1BIO\s0 I/O call. This is typically done with file BIOs.
212 .PP
213 \&\s-1SSL\s0 BIOs are the only current exception to this rule: they can request a
214 retry even if the underlying I/O structure is blocking, if a handshake
215 occurs during a call to \fIBIO_read()\fR. An application can retry the failed
216 call immediately or avoid this situation by setting \s-1SSL_MODE_AUTO_RETRY\s0
217 on the underlying \s-1SSL\s0 structure.
218 .PP
219 While an application may retry a failed non blocking call immediately
220 this is likely to be very inefficient because the call will fail
221 repeatedly until data can be processed or is available. An application
222 will normally wait until the necessary condition is satisfied. How
223 this is done depends on the underlying I/O structure.
224 .PP
225 For example if the cause is ultimately a socket and \fIBIO_should_read()\fR
226 is true then a call to \fIselect()\fR may be made to wait until data is
227 available and then retry the \s-1BIO\s0 operation. By combining the retry
228 conditions of several non blocking BIOs in a single \fIselect()\fR call
229 it is possible to service several BIOs in a single thread, though
230 the performance may be poor if \s-1SSL\s0 BIOs are present because long delays
231 can occur during the initial handshake process. 
232 .PP
233 It is possible for a \s-1BIO\s0 to block indefinitely if the underlying I/O
234 structure cannot process or return any data. This depends on the behaviour of
235 the platforms I/O functions. This is often not desirable: one solution
236 is to use non blocking I/O and use a timeout on the \fIselect()\fR (or
237 equivalent) call.
238 .SH "BUGS"
239 .IX Header "BUGS"
240 The OpenSSL \s-1ASN1\s0 functions cannot gracefully deal with non blocking I/O:
241 that is they cannot retry after a partial read or write. This is usually
242 worked around by only passing the relevant data to \s-1ASN1\s0 functions when
243 the entire structure can be read or written.
244 .SH "SEE ALSO"
245 .IX Header "SEE ALSO"
246 \&\s-1TBA\s0