secure/lib/libcrypto/man/BIO_should_retry.3

   1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-01-26" "1.0.2k" "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_retry, BIO_should_read, BIO_should_write,
 139 BIO_should_io_special, BIO_retry_type, BIO_should_retry,
 140 BIO_get_retry_BIO, BIO_get_retry_reason \- BIO retry functions
 141 .SH "SYNOPSIS"
 142 .IX Header "SYNOPSIS"
 143 .Vb 1
 144 \& #include <openssl/bio.h>
 145 \&
 146 \& #define BIO_should_read(a)             ((a)\->flags & BIO_FLAGS_READ)
 147 \& #define BIO_should_write(a)            ((a)\->flags & BIO_FLAGS_WRITE)
 148 \& #define BIO_should_io_special(a)       ((a)\->flags & BIO_FLAGS_IO_SPECIAL)
 149 \& #define BIO_retry_type(a)              ((a)\->flags & BIO_FLAGS_RWS)
 150 \& #define BIO_should_retry(a)            ((a)\->flags & BIO_FLAGS_SHOULD_RETRY)
 151 \&
 152 \& #define BIO_FLAGS_READ         0x01
 153 \& #define BIO_FLAGS_WRITE        0x02
 154 \& #define BIO_FLAGS_IO_SPECIAL   0x04
 155 \& #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
 156 \& #define BIO_FLAGS_SHOULD_RETRY 0x08
 157 \&
 158 \& BIO *  BIO_get_retry_BIO(BIO *bio, int *reason);
 159 \& int    BIO_get_retry_reason(BIO *bio);
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 These functions determine why a \s-1BIO\s0 is not able to read or write data.
 164 They will typically be called after a failed \fIBIO_read()\fR or \fIBIO_write()\fR
 165 call.
 166 .PP
 167 \&\fIBIO_should_retry()\fR is true if the call that produced this condition
 168 should then be retried at a later time.
 169 .PP
 170 If \fIBIO_should_retry()\fR is false then the cause is an error condition.
 171 .PP
 172 \&\fIBIO_should_read()\fR is true if the cause of the condition is that a \s-1BIO\s0
 173 needs to read data.
 174 .PP
 175 \&\fIBIO_should_write()\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_io_special()\fR is true if some \*(L"special\*(R" condition, that is a
 179 reason other than reading or writing is the cause of the condition.
 180 .PP
 181 \&\fIBIO_retry_type()\fR returns a mask of the cause of a retry condition
 182 consisting of the values \fB\s-1BIO_FLAGS_READ\s0\fR, \fB\s-1BIO_FLAGS_WRITE\s0\fR,
 183 \&\fB\s-1BIO_FLAGS_IO_SPECIAL\s0\fR though current \s-1BIO\s0 types will only set one of
 184 these.
 185 .PP
 186 \&\fIBIO_get_retry_BIO()\fR determines the precise reason for the special
 187 condition, it returns the \s-1BIO\s0 that caused this condition and if
 188 \&\fBreason\fR is not \s-1NULL\s0 it contains the reason code. The meaning of
 189 the reason code and the action that should be taken depends on
 190 the type of \s-1BIO\s0 that resulted in this condition.
 191 .PP
 192 \&\fIBIO_get_retry_reason()\fR returns the reason for a special condition if
 193 passed the relevant \s-1BIO,\s0 for example as returned by \fIBIO_get_retry_BIO()\fR.
 194 .SH "NOTES"
 195 .IX Header "NOTES"
 196 If \fIBIO_should_retry()\fR returns false then the precise \*(L"error condition\*(R"
 197 depends on the \s-1BIO\s0 type that caused it and the return code of the \s-1BIO\s0
 198 operation. For example if a call to \fIBIO_read()\fR on a socket \s-1BIO\s0 returns
 199 0 and \fIBIO_should_retry()\fR is false then the cause will be that the
 200 connection closed. A similar condition on a file \s-1BIO\s0 will mean that it
 201 has reached \s-1EOF.\s0 Some \s-1BIO\s0 types may place additional information on
 202 the error queue. For more details see the individual \s-1BIO\s0 type manual
 203 pages.
 204 .PP
 205 If the underlying I/O structure is in a blocking mode almost all current
 206 \&\s-1BIO\s0 types will not request a retry, because the underlying I/O
 207 calls will not. If the application knows that the \s-1BIO\s0 type will never
 208 signal a retry then it need not call \fIBIO_should_retry()\fR after a failed
 209 \&\s-1BIO I/O\s0 call. This is typically done with file BIOs.
 210 .PP
 211 \&\s-1SSL\s0 BIOs are the only current exception to this rule: they can request a
 212 retry even if the underlying I/O structure is blocking, if a handshake
 213 occurs during a call to \fIBIO_read()\fR. An application can retry the failed
 214 call immediately or avoid this situation by setting \s-1SSL_MODE_AUTO_RETRY\s0
 215 on the underlying \s-1SSL\s0 structure.
 216 .PP
 217 While an application may retry a failed non blocking call immediately
 218 this is likely to be very inefficient because the call will fail
 219 repeatedly until data can be processed or is available. An application
 220 will normally wait until the necessary condition is satisfied. How
 221 this is done depends on the underlying I/O structure.
 222 .PP
 223 For example if the cause is ultimately a socket and \fIBIO_should_read()\fR
 224 is true then a call to \fIselect()\fR may be made to wait until data is
 225 available and then retry the \s-1BIO\s0 operation. By combining the retry
 226 conditions of several non blocking BIOs in a single \fIselect()\fR call
 227 it is possible to service several BIOs in a single thread, though
 228 the performance may be poor if \s-1SSL\s0 BIOs are present because long delays
 229 can occur during the initial handshake process.
 230 .PP
 231 It is possible for a \s-1BIO\s0 to block indefinitely if the underlying I/O
 232 structure cannot process or return any data. This depends on the behaviour of
 233 the platforms I/O functions. This is often not desirable: one solution
 234 is to use non blocking I/O and use a timeout on the \fIselect()\fR (or
 235 equivalent) call.
 236 .SH "BUGS"
 237 .IX Header "BUGS"
 238 The OpenSSL \s-1ASN1\s0 functions cannot gracefully deal with non blocking I/O:
 239 that is they cannot retry after a partial read or write. This is usually
 240 worked around by only passing the relevant data to \s-1ASN1\s0 functions when
 241 the entire structure can be read or written.
 242 .SH "SEE ALSO"
 243 .IX Header "SEE ALSO"
 244 \&\s-1TBA\s0