← Back to branch summary

~ubuntu-branches/ubuntu/hardy/openssl/hardy-security

« back to all changes in this revision

Viewing changes to doc/crypto/BIO_should_retry.pod

  • Committer: Bazaar Package Importer
  • Author(s): Christoph Martin
  • Date: 2004-05-24 17:02:29 UTC
  • Revision ID: james.westby@ubuntu.com-20040524170229-ixlo08bbbly0xied
Tags: upstream-0.9.7d
Import upstream version 0.9.7d

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/crypto/BIO_should_retry.pod
 
1
=pod
 
2
 
 
3
=head1 NAME
 
4
 
 
5
BIO_should_retry, BIO_should_read, BIO_should_write,
 
6
BIO_should_io_special, BIO_retry_type, BIO_should_retry,
 
7
BIO_get_retry_BIO, BIO_get_retry_reason - BIO retry functions
 
8
 
 
9
=head1 SYNOPSIS
 
10
 
 
11
 #include <openssl/bio.h>
 
12
 
 
13
 #define BIO_should_read(a)             ((a)->flags & BIO_FLAGS_READ)
 
14
 #define BIO_should_write(a)            ((a)->flags & BIO_FLAGS_WRITE)
 
15
 #define BIO_should_io_special(a)       ((a)->flags & BIO_FLAGS_IO_SPECIAL)
 
16
 #define BIO_retry_type(a)              ((a)->flags & BIO_FLAGS_RWS)
 
17
 #define BIO_should_retry(a)            ((a)->flags & BIO_FLAGS_SHOULD_RETRY)
 
18
 
 
19
 #define BIO_FLAGS_READ         0x01
 
20
 #define BIO_FLAGS_WRITE        0x02
 
21
 #define BIO_FLAGS_IO_SPECIAL   0x04
 
22
 #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
 
23
 #define BIO_FLAGS_SHOULD_RETRY 0x08
 
24
 
 
25
 BIO *  BIO_get_retry_BIO(BIO *bio, int *reason);
 
26
 int    BIO_get_retry_reason(BIO *bio);
 
27
 
 
28
=head1 DESCRIPTION
 
29
 
 
30
These functions determine why a BIO is not able to read or write data.
 
31
They will typically be called after a failed BIO_read() or BIO_write()
 
32
call.
 
33
 
 
34
BIO_should_retry() is true if the call that produced this condition
 
35
should then be retried at a later time.
 
36
 
 
37
If BIO_should_retry() is false then the cause is an error condition.
 
38
 
 
39
BIO_should_read() is true if the cause of the condition is that a BIO
 
40
needs to read data.
 
41
 
 
42
BIO_should_write() is true if the cause of the condition is that a BIO
 
43
needs to read data.
 
44
 
 
45
BIO_should_io_special() is true if some "special" condition, that is a
 
46
reason other than reading or writing is the cause of the condition.
 
47
 
 
48
BIO_get_retry_reason() returns a mask of the cause of a retry condition
 
49
consisting of the values B<BIO_FLAGS_READ>, B<BIO_FLAGS_WRITE>,
 
50
B<BIO_FLAGS_IO_SPECIAL> though current BIO types will only set one of
 
51
these.
 
52
 
 
53
BIO_get_retry_BIO() determines the precise reason for the special
 
54
condition, it returns the BIO that caused this condition and if 
 
55
B<reason> is not NULL it contains the reason code. The meaning of
 
56
the reason code and the action that should be taken depends on
 
57
the type of BIO that resulted in this condition.
 
58
 
 
59
BIO_get_retry_reason() returns the reason for a special condition if
 
60
passed the relevant BIO, for example as returned by BIO_get_retry_BIO().
 
61
 
 
62
=head1 NOTES
 
63
 
 
64
If BIO_should_retry() returns false then the precise "error condition"
 
65
depends on the BIO type that caused it and the return code of the BIO
 
66
operation. For example if a call to BIO_read() on a socket BIO returns
 
67
0 and BIO_should_retry() is false then the cause will be that the
 
68
connection closed. A similar condition on a file BIO will mean that it
 
69
has reached EOF. Some BIO types may place additional information on
 
70
the error queue. For more details see the individual BIO type manual
 
71
pages.
 
72
 
 
73
If the underlying I/O structure is in a blocking mode almost all current
 
74
BIO types will not request a retry, because the underlying I/O
 
75
calls will not. If the application knows that the BIO type will never
 
76
signal a retry then it need not call BIO_should_retry() after a failed
 
77
BIO I/O call. This is typically done with file BIOs.
 
78
 
 
79
SSL BIOs are the only current exception to this rule: they can request a
 
80
retry even if the underlying I/O structure is blocking, if a handshake
 
81
occurs during a call to BIO_read(). An application can retry the failed
 
82
call immediately or avoid this situation by setting SSL_MODE_AUTO_RETRY
 
83
on the underlying SSL structure.
 
84
 
 
85
While an application may retry a failed non blocking call immediately
 
86
this is likely to be very inefficient because the call will fail
 
87
repeatedly until data can be processed or is available. An application
 
88
will normally wait until the necessary condition is satisfied. How
 
89
this is done depends on the underlying I/O structure.
 
90
 
 
91
For example if the cause is ultimately a socket and BIO_should_read()
 
92
is true then a call to select() may be made to wait until data is
 
93
available and then retry the BIO operation. By combining the retry
 
94
conditions of several non blocking BIOs in a single select() call
 
95
it is possible to service several BIOs in a single thread, though
 
96
the performance may be poor if SSL BIOs are present because long delays
 
97
can occur during the initial handshake process. 
 
98
 
 
99
It is possible for a BIO to block indefinitely if the underlying I/O
 
100
structure cannot process or return any data. This depends on the behaviour of
 
101
the platforms I/O functions. This is often not desirable: one solution
 
102
is to use non blocking I/O and use a timeout on the select() (or
 
103
equivalent) call.
 
104
 
 
105
=head1 BUGS
 
106
 
 
107
The OpenSSL ASN1 functions cannot gracefully deal with non blocking I/O:
 
108
that is they cannot retry after a partial read or write. This is usually
 
109
worked around by only passing the relevant data to ASN1 functions when
 
110
the entire structure can be read or written.
 
111
 
 
112
=head1 SEE ALSO
 
113
 
 
114
TBA