secure/lib/libcrypto/man/BIO_should_retry.3

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