diff options
author | Matt Caswell <matt@openssl.org> | 2016-03-29 14:25:23 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2016-03-29 17:40:54 +0100 |
commit | 85556b4dec97b1402e1edeaef6ffc0e9cd931457 (patch) | |
tree | 43a161b0a45ee1fe398d9ce3e8c9137e3557b6a1 /doc/crypto/BIO_should_retry.pod | |
parent | 173755255837d22c2bfbfe455164c67758224cb1 (diff) |
Add documentation for BIO functions
Add the documentation for new BIO functions added as a result of
making BIO and BIO_METHOD opaque.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/crypto/BIO_should_retry.pod')
-rw-r--r-- | doc/crypto/BIO_should_retry.pod | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/crypto/BIO_should_retry.pod b/doc/crypto/BIO_should_retry.pod index b6d51f719d..f5b47b37b4 100644 --- a/doc/crypto/BIO_should_retry.pod +++ b/doc/crypto/BIO_should_retry.pod @@ -4,7 +4,8 @@ BIO_should_retry, 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 retry functions +BIO_get_retry_BIO, BIO_get_retry_reason, BIO_set_retry_reason - BIO retry +functions =head1 SYNOPSIS @@ -22,8 +23,9 @@ BIO_get_retry_BIO, BIO_get_retry_reason - BIO retry functions #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL) #define BIO_FLAGS_SHOULD_RETRY 0x08 - BIO * BIO_get_retry_BIO(BIO *bio, int *reason); - int BIO_get_retry_reason(BIO *bio); + BIO *BIO_get_retry_BIO(BIO *bio, int *reason); + int BIO_get_retry_reason(BIO *bio); + void BIO_set_retry_reason(BIO *bio, int reason); =head1 DESCRIPTION @@ -59,6 +61,9 @@ the type of BIO that resulted in this condition. BIO_get_retry_reason() returns the reason for a special condition if passed the relevant BIO, for example as returned by BIO_get_retry_BIO(). +BIO_set_retry_reason() sets the retry reason for a special condition for a given +BIO. This would usually only be called by BIO implementations. + =head1 NOTES If BIO_should_retry() returns false then the precise "error condition" @@ -111,4 +116,11 @@ the entire structure can be read or written. =head1 SEE ALSO -TBA +L<bio> + +=head1 HISTORY + +The BIO_get_retry_reason() and BIO_set_retry_reason() functions were added in +OpenSSL version 1.1.0. + +=cut |