secure/lib/libcrypto/man/BIO_should_retry.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& int BIO_should_read(BIO *b);
 145 \& int BIO_should_write(BIO *b);
 146 \& int BIO_should_io_special(iBIO *b);
 147 \& int BIO_retry_type(BIO *b);
 148 \& int BIO_should_retry(BIO *b);
 149 \&
 150 \& BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
 151 \& int BIO_get_retry_reason(BIO *bio);
 152 \& void BIO_set_retry_reason(BIO *bio, int reason);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 These functions determine why a \s-1BIO\s0 is not able to read or write data.
 157 They will typically be called after a failed \fIBIO_read_ex()\fR or \fIBIO_write_ex()\fR
 158 call.
 159 .PP
 160 \&\fIBIO_should_retry()\fR is true if the call that produced this condition
 161 should then be retried at a later time.
 162 .PP
 163 If \fIBIO_should_retry()\fR is false then the cause is an error condition.
 164 .PP
 165 \&\fIBIO_should_read()\fR is true if the cause of the condition is that the \s-1BIO\s0
 166 has insufficient data to return. Check for readability and/or retry the
 167 last operation.
 168 .PP
 169 \&\fIBIO_should_write()\fR is true if the cause of the condition is that the \s-1BIO\s0
 170 has pending data to write. Check for writability and/or retry the
 171 last operation.
 172 .PP
 173 \&\fIBIO_should_io_special()\fR is true if some \*(L"special\*(R" condition, that is a
 174 reason other than reading or writing is the cause of the condition.
 175 .PP
 176 \&\fIBIO_retry_type()\fR returns a mask of the cause of a retry condition
 177 consisting of the values \fB\s-1BIO_FLAGS_READ\s0\fR, \fB\s-1BIO_FLAGS_WRITE\s0\fR,
 178 \&\fB\s-1BIO_FLAGS_IO_SPECIAL\s0\fR though current \s-1BIO\s0 types will only set one of
 179 these.
 180 .PP
 181 \&\fIBIO_get_retry_BIO()\fR determines the precise reason for the special
 182 condition, it returns the \s-1BIO\s0 that caused this condition and if
 183 \&\fBreason\fR is not \s-1NULL\s0 it contains the reason code. The meaning of
 184 the reason code and the action that should be taken depends on
 185 the type of \s-1BIO\s0 that resulted in this condition.
 186 .PP
 187 \&\fIBIO_get_retry_reason()\fR returns the reason for a special condition if
 188 passed the relevant \s-1BIO,\s0 for example as returned by \fIBIO_get_retry_BIO()\fR.
 189 .PP
 190 \&\fIBIO_set_retry_reason()\fR sets the retry reason for a special condition for a given
 191 \&\s-1BIO.\s0 This would usually only be called by \s-1BIO\s0 implementations.
 192 .SH "NOTES"
 193 .IX Header "NOTES"
 194 \&\fIBIO_should_read()\fR, \fIBIO_should_write()\fR, \fIBIO_should_io_special()\fR,
 195 \&\fIBIO_retry_type()\fR, and \fIBIO_should_retry()\fR, are implemented as macros.
 196 .PP
 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_ex()\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 "RETURN VALUES"
 244 .IX Header "RETURN VALUES"
 245 \&\fIBIO_should_read()\fR, \fIBIO_should_write()\fR, \fIBIO_should_io_special()\fR, and
 246 \&\fIBIO_should_retry()\fR return either 1 or 0 based on the actual conditions
 247 of the \fB\s-1BIO\s0\fR.
 248 .PP
 249 \&\fIBIO_retry_type()\fR returns a flag combination presenting the cause of a retry
 250 condition or false if there is no retry condition.
 251 .PP
 252 \&\fIBIO_get_retry_BIO()\fR returns a valid \fB\s-1BIO\s0\fR structure.
 253 .PP
 254 \&\fIBIO_get_retry_reason()\fR returns the reason for a special condition.
 255 .SH "SEE ALSO"
 256 .IX Header "SEE ALSO"
 257 bio
 258 .SH "HISTORY"
 259 .IX Header "HISTORY"
 260 The \fIBIO_get_retry_reason()\fR and \fIBIO_set_retry_reason()\fR functions were added in
 261 OpenSSL 1.1.0.
 262 .SH "COPYRIGHT"
 263 .IX Header "COPYRIGHT"
 264 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 265 .PP
 266 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 267 this file except in compliance with the License.  You can obtain a copy
 268 in the file \s-1LICENSE\s0 in the source distribution or at
 269 <https://www.openssl.org/source/license.html>.