summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO_s_bio.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/BIO_s_bio.3')
-rw-r--r--src/lib/libcrypto/man/BIO_s_bio.336
1 files changed, 18 insertions, 18 deletions
diff --git a/src/lib/libcrypto/man/BIO_s_bio.3 b/src/lib/libcrypto/man/BIO_s_bio.3
index c7d602990e..ccd3bf8ef9 100644
--- a/src/lib/libcrypto/man/BIO_s_bio.3
+++ b/src/lib/libcrypto/man/BIO_s_bio.3
@@ -1,6 +1,6 @@
1.\" $OpenBSD: BIO_s_bio.3,v 1.4 2016/11/06 15:52:50 jmc Exp $ 1.\" $OpenBSD: BIO_s_bio.3,v 1.5 2016/11/07 15:52:47 jmc Exp $
2.\" 2.\"
3.Dd $Mdocdate: November 6 2016 $ 3.Dd $Mdocdate: November 7 2016 $
4.Dt BIO_S_BIO 3 4.Dt BIO_S_BIO 3
5.Os 5.Os
6.Sh NAME 6.Sh NAME
@@ -79,7 +79,7 @@ have all the data processed by the chain under application control.
79.Pp 79.Pp
80One typical use of BIO pairs is 80One typical use of BIO pairs is
81to place TLS/SSL I/O under application control. 81to place TLS/SSL I/O under application control.
82This can be used when the application wishes to use a non standard 82This can be used when the application wishes to use a non-standard
83transport for TLS/SSL or the normal socket routines are inappropriate. 83transport for TLS/SSL or the normal socket routines are inappropriate.
84.Pp 84.Pp
85Calls to 85Calls to
@@ -147,7 +147,7 @@ does not check whether
147.Fa bio1 147.Fa bio1
148or 148or
149.Fa bio2 149.Fa bio2
150do point to some other BIO, the values are overwritten, 150point to some other BIO; the values are overwritten and
151.Xr BIO_free 3 151.Xr BIO_free 3
152is not called. 152is not called.
153.Pp 153.Pp
@@ -186,19 +186,7 @@ never returns an amount larger than that returned by
186can also be used to reset the value returned by 186can also be used to reset the value returned by
187.Fn BIO_get_read_request 187.Fn BIO_get_read_request
188to zero. 188to zero.
189.Sh RETURN VALUES 189.Pp
190.Fn BIO_new_bio_pair
191returns 1 on success, with the new BIOs available in
192.Fa bio1
193and
194.Fa bio2 ,
195or 0 on failure, with NULL pointers stored into the locations for
196.Fa bio1
197and
198.Fa bio2 .
199Check the error stack for more information.
200.\" XXX More return values need to be added here.
201.Sh NOTES
202Both halves of a BIO pair should be freed. 190Both halves of a BIO pair should be freed.
203Even if one half is implicitly freed due to a 191Even if one half is implicitly freed due to a
204.Xr BIO_free_all 3 192.Xr BIO_free_all 3
@@ -233,12 +221,24 @@ will be true.
233If the application then waits for data to become available 221If the application then waits for data to become available
234on the underlying transport before flushing the write buffer, 222on the underlying transport before flushing the write buffer,
235it will never succeed because the request was never sent. 223it will never succeed because the request was never sent.
224.Sh RETURN VALUES
225.Fn BIO_new_bio_pair
226returns 1 on success, with the new BIOs available in
227.Fa bio1
228and
229.Fa bio2 ,
230or 0 on failure, with NULL pointers stored into the locations for
231.Fa bio1
232and
233.Fa bio2 .
234Check the error stack for more information.
235.\" XXX More return values need to be added here.
236.Sh EXAMPLES 236.Sh EXAMPLES
237The BIO pair can be used to have full control 237The BIO pair can be used to have full control
238over the network access of an application. 238over the network access of an application.
239The application can call 239The application can call
240.Xr select 2 240.Xr select 2
241on the socket as required without having to go through the SSL-interface. 241on the socket as required without having to go through the SSL interface.
242.Bd -literal -offset 2n 242.Bd -literal -offset 2n
243BIO *internal_bio, *network_bio; 243BIO *internal_bio, *network_bio;
244\&... 244\&...