ng_eiface.4: Comment out some xrefs to ng_vlan(4) which we don't have.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_should_retry.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
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 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "BIO_should_retry 3"
135 .TH BIO_should_retry 3 "2009-11-06" "0.9.8l" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 BIO_should_retry, BIO_should_read, BIO_should_write,
142 BIO_should_io_special, BIO_retry_type, BIO_should_retry,
143 BIO_get_retry_BIO, BIO_get_retry_reason \- BIO retry functions
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 .Vb 1
147 \& #include <openssl/bio.h>
148 \&
149 \& #define BIO_should_read(a)             ((a)\->flags & BIO_FLAGS_READ)
150 \& #define BIO_should_write(a)            ((a)\->flags & BIO_FLAGS_WRITE)
151 \& #define BIO_should_io_special(a)       ((a)\->flags & BIO_FLAGS_IO_SPECIAL)
152 \& #define BIO_retry_type(a)              ((a)\->flags & BIO_FLAGS_RWS)
153 \& #define BIO_should_retry(a)            ((a)\->flags & BIO_FLAGS_SHOULD_RETRY)
154 \&
155 \& #define BIO_FLAGS_READ         0x01
156 \& #define BIO_FLAGS_WRITE        0x02
157 \& #define BIO_FLAGS_IO_SPECIAL   0x04
158 \& #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
159 \& #define BIO_FLAGS_SHOULD_RETRY 0x08
160 \&
161 \& BIO *  BIO_get_retry_BIO(BIO *bio, int *reason);
162 \& int    BIO_get_retry_reason(BIO *bio);
163 .Ve
164 .SH "DESCRIPTION"
165 .IX Header "DESCRIPTION"
166 These functions determine why a \s-1BIO\s0 is not able to read or write data.
167 They will typically be called after a failed \fIBIO_read()\fR or \fIBIO_write()\fR
168 call.
169 .PP
170 \&\fIBIO_should_retry()\fR is true if the call that produced this condition
171 should then be retried at a later time.
172 .PP
173 If \fIBIO_should_retry()\fR is false then the cause is an error condition.
174 .PP
175 \&\fIBIO_should_read()\fR is true if the cause of the condition is that a \s-1BIO\s0
176 needs to read data.
177 .PP
178 \&\fIBIO_should_write()\fR is true if the cause of the condition is that a \s-1BIO\s0
179 needs to read data.
180 .PP
181 \&\fIBIO_should_io_special()\fR is true if some \*(L"special\*(R" condition, that is a
182 reason other than reading or writing is the cause of the condition.
183 .PP
184 \&\fIBIO_get_retry_reason()\fR returns a mask of the cause of a retry condition
185 consisting of the values \fB\s-1BIO_FLAGS_READ\s0\fR, \fB\s-1BIO_FLAGS_WRITE\s0\fR,
186 \&\fB\s-1BIO_FLAGS_IO_SPECIAL\s0\fR though current \s-1BIO\s0 types will only set one of
187 these.
188 .PP
189 \&\fIBIO_get_retry_BIO()\fR determines the precise reason for the special
190 condition, it returns the \s-1BIO\s0 that caused this condition and if 
191 \&\fBreason\fR is not \s-1NULL\s0 it contains the reason code. The meaning of
192 the reason code and the action that should be taken depends on
193 the type of \s-1BIO\s0 that resulted in this condition.
194 .PP
195 \&\fIBIO_get_retry_reason()\fR returns the reason for a special condition if
196 passed the relevant \s-1BIO\s0, for example as returned by \fIBIO_get_retry_BIO()\fR.
197 .SH "NOTES"
198 .IX Header "NOTES"
199 If \fIBIO_should_retry()\fR returns false then the precise \*(L"error condition\*(R"
200 depends on the \s-1BIO\s0 type that caused it and the return code of the \s-1BIO\s0
201 operation. For example if a call to \fIBIO_read()\fR on a socket \s-1BIO\s0 returns
202 0 and \fIBIO_should_retry()\fR is false then the cause will be that the
203 connection closed. A similar condition on a file \s-1BIO\s0 will mean that it
204 has reached \s-1EOF\s0. Some \s-1BIO\s0 types may place additional information on
205 the error queue. For more details see the individual \s-1BIO\s0 type manual
206 pages.
207 .PP
208 If the underlying I/O structure is in a blocking mode almost all current
209 \&\s-1BIO\s0 types will not request a retry, because the underlying I/O
210 calls will not. If the application knows that the \s-1BIO\s0 type will never
211 signal a retry then it need not call \fIBIO_should_retry()\fR after a failed
212 \&\s-1BIO\s0 I/O call. This is typically done with file BIOs.
213 .PP
214 \&\s-1SSL\s0 BIOs are the only current exception to this rule: they can request a
215 retry even if the underlying I/O structure is blocking, if a handshake
216 occurs during a call to \fIBIO_read()\fR. An application can retry the failed
217 call immediately or avoid this situation by setting \s-1SSL_MODE_AUTO_RETRY\s0
218 on the underlying \s-1SSL\s0 structure.
219 .PP
220 While an application may retry a failed non blocking call immediately
221 this is likely to be very inefficient because the call will fail
222 repeatedly until data can be processed or is available. An application
223 will normally wait until the necessary condition is satisfied. How
224 this is done depends on the underlying I/O structure.
225 .PP
226 For example if the cause is ultimately a socket and \fIBIO_should_read()\fR
227 is true then a call to \fIselect()\fR may be made to wait until data is
228 available and then retry the \s-1BIO\s0 operation. By combining the retry
229 conditions of several non blocking BIOs in a single \fIselect()\fR call
230 it is possible to service several BIOs in a single thread, though
231 the performance may be poor if \s-1SSL\s0 BIOs are present because long delays
232 can occur during the initial handshake process.
233 .PP
234 It is possible for a \s-1BIO\s0 to block indefinitely if the underlying I/O
235 structure cannot process or return any data. This depends on the behaviour of
236 the platforms I/O functions. This is often not desirable: one solution
237 is to use non blocking I/O and use a timeout on the \fIselect()\fR (or
238 equivalent) call.
239 .SH "BUGS"
240 .IX Header "BUGS"
241 The OpenSSL \s-1ASN1\s0 functions cannot gracefully deal with non blocking I/O:
242 that is they cannot retry after a partial read or write. This is usually
243 worked around by only passing the relevant data to \s-1ASN1\s0 functions when
244 the entire structure can be read or written.
245 .SH "SEE ALSO"
246 .IX Header "SEE ALSO"
247 \&\s-1TBA\s0