secure/lib/libcrypto/man/man3/BIO_should_retry.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   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 >0, 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 "2020-09-22" "1.1.1h" "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_read, BIO_should_write, BIO_should_io_special, BIO_retry_type, BIO_should_retry, BIO_get_retry_BIO, BIO_get_retry_reason, BIO_set_retry_reason \- BIO retry functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 \&
 148 \& int BIO_should_read(BIO *b);
 149 \& int BIO_should_write(BIO *b);
 150 \& int BIO_should_io_special(iBIO *b);
 151 \& int BIO_retry_type(BIO *b);
 152 \& int BIO_should_retry(BIO *b);
 153 \&
 154 \& BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
 155 \& int BIO_get_retry_reason(BIO *bio);
 156 \& void BIO_set_retry_reason(BIO *bio, int reason);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 These functions determine why a \s-1BIO\s0 is not able to read or write data.
 161 They will typically be called after a failed \fBBIO_read_ex()\fR or \fBBIO_write_ex()\fR
 162 call.
 163 .PP
 164 \&\fBBIO_should_retry()\fR is true if the call that produced this condition
 165 should then be retried at a later time.
 166 .PP
 167 If \fBBIO_should_retry()\fR is false then the cause is an error condition.
 168 .PP
 169 \&\fBBIO_should_read()\fR is true if the cause of the condition is that the \s-1BIO\s0
 170 has insufficient data to return. Check for readability and/or retry the
 171 last operation.
 172 .PP
 173 \&\fBBIO_should_write()\fR is true if the cause of the condition is that the \s-1BIO\s0
 174 has pending data to write. Check for writability and/or retry the
 175 last operation.
 176 .PP
 177 \&\fBBIO_should_io_special()\fR is true if some \*(L"special\*(R" condition, that is a
 178 reason other than reading or writing is the cause of the condition.
 179 .PP
 180 \&\fBBIO_retry_type()\fR returns a mask of the cause of a retry condition
 181 consisting of the values \fB\s-1BIO_FLAGS_READ\s0\fR, \fB\s-1BIO_FLAGS_WRITE\s0\fR,
 182 \&\fB\s-1BIO_FLAGS_IO_SPECIAL\s0\fR though current \s-1BIO\s0 types will only set one of
 183 these.
 184 .PP
 185 \&\fBBIO_get_retry_BIO()\fR determines the precise reason for the special
 186 condition, it returns the \s-1BIO\s0 that caused this condition and if
 187 \&\fBreason\fR is not \s-1NULL\s0 it contains the reason code. The meaning of
 188 the reason code and the action that should be taken depends on
 189 the type of \s-1BIO\s0 that resulted in this condition.
 190 .PP
 191 \&\fBBIO_get_retry_reason()\fR returns the reason for a special condition if
 192 passed the relevant \s-1BIO,\s0 for example as returned by \fBBIO_get_retry_BIO()\fR.
 193 .PP
 194 \&\fBBIO_set_retry_reason()\fR sets the retry reason for a special condition for a given
 195 \&\s-1BIO.\s0 This would usually only be called by \s-1BIO\s0 implementations.
 196 .SH "NOTES"
 197 .IX Header "NOTES"
 198 \&\fBBIO_should_read()\fR, \fBBIO_should_write()\fR, \fBBIO_should_io_special()\fR,
 199 \&\fBBIO_retry_type()\fR, and \fBBIO_should_retry()\fR, are implemented as macros.
 200 .PP
 201 If \fBBIO_should_retry()\fR returns false then the precise \*(L"error condition\*(R"
 202 depends on the \s-1BIO\s0 type that caused it and the return code of the \s-1BIO\s0
 203 operation. For example if a call to \fBBIO_read_ex()\fR on a socket \s-1BIO\s0 returns
 204 0 and \fBBIO_should_retry()\fR is false then the cause will be that the
 205 connection closed. A similar condition on a file \s-1BIO\s0 will mean that it
 206 has reached \s-1EOF.\s0 Some \s-1BIO\s0 types may place additional information on
 207 the error queue. For more details see the individual \s-1BIO\s0 type manual
 208 pages.
 209 .PP
 210 If the underlying I/O structure is in a blocking mode almost all current
 211 \&\s-1BIO\s0 types will not request a retry, because the underlying I/O
 212 calls will not. If the application knows that the \s-1BIO\s0 type will never
 213 signal a retry then it need not call \fBBIO_should_retry()\fR after a failed
 214 \&\s-1BIO I/O\s0 call. This is typically done with file BIOs.
 215 .PP
 216 \&\s-1SSL\s0 BIOs are the only current exception to this rule: they can request a
 217 retry even if the underlying I/O structure is blocking, if a handshake
 218 occurs during a call to \fBBIO_read()\fR. An application can retry the failed
 219 call immediately or avoid this situation by setting \s-1SSL_MODE_AUTO_RETRY\s0
 220 on the underlying \s-1SSL\s0 structure.
 221 .PP
 222 While an application may retry a failed non blocking call immediately
 223 this is likely to be very inefficient because the call will fail
 224 repeatedly until data can be processed or is available. An application
 225 will normally wait until the necessary condition is satisfied. How
 226 this is done depends on the underlying I/O structure.
 227 .PP
 228 For example if the cause is ultimately a socket and \fBBIO_should_read()\fR
 229 is true then a call to \fBselect()\fR may be made to wait until data is
 230 available and then retry the \s-1BIO\s0 operation. By combining the retry
 231 conditions of several non blocking BIOs in a single \fBselect()\fR call
 232 it is possible to service several BIOs in a single thread, though
 233 the performance may be poor if \s-1SSL\s0 BIOs are present because long delays
 234 can occur during the initial handshake process.
 235 .PP
 236 It is possible for a \s-1BIO\s0 to block indefinitely if the underlying I/O
 237 structure cannot process or return any data. This depends on the behaviour of
 238 the platforms I/O functions. This is often not desirable: one solution
 239 is to use non blocking I/O and use a timeout on the \fBselect()\fR (or
 240 equivalent) call.
 241 .SH "BUGS"
 242 .IX Header "BUGS"
 243 The OpenSSL \s-1ASN1\s0 functions cannot gracefully deal with non blocking I/O:
 244 that is they cannot retry after a partial read or write. This is usually
 245 worked around by only passing the relevant data to \s-1ASN1\s0 functions when
 246 the entire structure can be read or written.
 247 .SH "RETURN VALUES"
 248 .IX Header "RETURN VALUES"
 249 \&\fBBIO_should_read()\fR, \fBBIO_should_write()\fR, \fBBIO_should_io_special()\fR, and
 250 \&\fBBIO_should_retry()\fR return either 1 or 0 based on the actual conditions
 251 of the \fB\s-1BIO\s0\fR.
 252 .PP
 253 \&\fBBIO_retry_type()\fR returns a flag combination presenting the cause of a retry
 254 condition or false if there is no retry condition.
 255 .PP
 256 \&\fBBIO_get_retry_BIO()\fR returns a valid \fB\s-1BIO\s0\fR structure.
 257 .PP
 258 \&\fBBIO_get_retry_reason()\fR returns the reason for a special condition.
 259 .SH "SEE ALSO"
 260 .IX Header "SEE ALSO"
 261 bio
 262 .SH "HISTORY"
 263 .IX Header "HISTORY"
 264 The \fBBIO_get_retry_reason()\fR and \fBBIO_set_retry_reason()\fR functions were added in
 265 OpenSSL 1.1.0.
 266 .SH "COPYRIGHT"
 267 .IX Header "COPYRIGHT"
 268 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 269 .PP
 270 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 271 this file except in compliance with the License.  You can obtain a copy
 272 in the file \s-1LICENSE\s0 in the source distribution or at
 273 <https://www.openssl.org/source/license.html>.