summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschwarze <>2022-11-27 19:11:11 +0000
committerschwarze <>2022-11-27 19:11:11 +0000
commit7d6ea40c9e0e0897e7765f0607c1ab1f57aa70e0 (patch)
treea4294a5140a2981d98ffe2503891ca471186b0ae
parent246954626bd75b061be0645ab9659db51b2c4e38 (diff)
downloadopenbsd-7d6ea40c9e0e0897e7765f0607c1ab1f57aa70e0.tar.gz
openbsd-7d6ea40c9e0e0897e7765f0607c1ab1f57aa70e0.tar.bz2
openbsd-7d6ea40c9e0e0897e7765f0607c1ab1f57aa70e0.zip
In bio.h rev. 1.50 and rev. 1.51, tb@ provided BIO_set_retry_reason(3).
Merge the documentation from the OpenSSL 1.1.1 branch, which is still under a free license, tweaked by me.
-rw-r--r--src/lib/libcrypto/man/BIO_should_retry.324
1 files changed, 20 insertions, 4 deletions
diff --git a/src/lib/libcrypto/man/BIO_should_retry.3 b/src/lib/libcrypto/man/BIO_should_retry.3
index 43b19b89e1..4d7a214db6 100644
--- a/src/lib/libcrypto/man/BIO_should_retry.3
+++ b/src/lib/libcrypto/man/BIO_should_retry.3
@@ -1,5 +1,5 @@
1.\" $OpenBSD: BIO_should_retry.3,v 1.9 2018/12/19 21:12:58 schwarze Exp $ 1.\" $OpenBSD: BIO_should_retry.3,v 1.10 2022/11/27 19:11:11 schwarze Exp $
2.\" full merge up to: OpenSSL 60e24554 Apr 6 14:45:18 2010 +0000 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
3.\" selective merge up to: OpenSSL 57fd5170 May 13 11:24:11 2018 +0200 3.\" selective merge up to: OpenSSL 57fd5170 May 13 11:24:11 2018 +0200
4.\" 4.\"
5.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -49,7 +49,7 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 51.\"
52.Dd $Mdocdate: December 19 2018 $ 52.Dd $Mdocdate: November 27 2022 $
53.Dt BIO_SHOULD_RETRY 3 53.Dt BIO_SHOULD_RETRY 3
54.Os 54.Os
55.Sh NAME 55.Sh NAME
@@ -59,7 +59,8 @@
59.Nm BIO_retry_type , 59.Nm BIO_retry_type ,
60.Nm BIO_should_retry , 60.Nm BIO_should_retry ,
61.Nm BIO_get_retry_BIO , 61.Nm BIO_get_retry_BIO ,
62.Nm BIO_get_retry_reason 62.Nm BIO_get_retry_reason ,
63.Nm BIO_set_retry_reason
63.Nd BIO retry functions 64.Nd BIO retry functions
64.Sh SYNOPSIS 65.Sh SYNOPSIS
65.In openssl/bio.h 66.In openssl/bio.h
@@ -98,6 +99,11 @@
98.Fo BIO_get_retry_reason 99.Fo BIO_get_retry_reason
99.Fa "BIO *bio" 100.Fa "BIO *bio"
100.Fc 101.Fc
102.Ft void
103.Fo BIO_set_retry_reason
104.Fa "BIO *bio"
105.Fa "int reason"
106.Fc
101.Sh DESCRIPTION 107.Sh DESCRIPTION
102These functions determine why a BIO is not able to read or write data. 108These functions determine why a BIO is not able to read or write data.
103They will typically be called after a failed 109They will typically be called after a failed
@@ -147,6 +153,12 @@ returns the reason for a special condition
147if passed the relevant BIO, for example as returned by 153if passed the relevant BIO, for example as returned by
148.Fn BIO_get_retry_BIO . 154.Fn BIO_get_retry_BIO .
149.Pp 155.Pp
156.Fn BIO_set_retry_reason
157sets the retry reason for a special condition for the given
158.Fa bio .
159It is intended to be called by functions implementing a BIO type
160rather than by functions merely using BIOs.
161.Pp
150.Fn BIO_should_retry , 162.Fn BIO_should_retry ,
151.Fn BIO_should_read , 163.Fn BIO_should_read ,
152.Fn BIO_should_write , 164.Fn BIO_should_write ,
@@ -229,6 +241,10 @@ and
229first appeared in SSLeay 0.8.0. 241first appeared in SSLeay 0.8.0.
230All these functions have been available since 242All these functions have been available since
231.Ox 2.4 . 243.Ox 2.4 .
244.Pp
245.Fn BIO_set_retry_reason
246first appeared in OpenSSL 1.1.0 and has been available since
247.Ox 7.1 .
232.Sh BUGS 248.Sh BUGS
233The OpenSSL ASN.1 functions cannot gracefully deal with non-blocking I/O: 249The OpenSSL ASN.1 functions cannot gracefully deal with non-blocking I/O:
234they cannot retry after a partial read or write. 250they cannot retry after a partial read or write.