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