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