summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_set_bio.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/doc/SSL_set_bio.3')
-rw-r--r--src/lib/libssl/doc/SSL_set_bio.348
1 files changed, 48 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_set_bio.3 b/src/lib/libssl/doc/SSL_set_bio.3
new file mode 100644
index 0000000000..62bc22370d
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_set_bio.3
@@ -0,0 +1,48 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_SET_BIO 3
3.Os
4.Sh NAME
5.Nm SSL_set_bio
6.Nd connect the SSL object with a BIO
7.Sh SYNOPSIS
8.In openssl/ssl.h
9.Ft void
10.Fn SSL_set_bio "SSL *ssl" "BIO *rbio" "BIO *wbio"
11.Sh DESCRIPTION
12.Fn SSL_set_bio
13connects the
14.Vt BIO Ns
15s
16.Fa rbio
17and
18.Fa wbio
19for the read and write operations of the TLS/SSL (encrypted) side of
20.Fa ssl .
21.Pp
22The SSL engine inherits the behaviour of
23.Fa rbio
24and
25.Fa wbio ,
26respectively.
27If a
28.Vt BIO
29is non-blocking, the
30.Fa ssl
31will also have non-blocking behaviour.
32.Pp
33If there was already a
34.Vt BIO
35connected to
36.Fa ssl ,
37.Xr BIO_free 3
38will be called (for both the reading and writing side, if different).
39.Sh RETURN VALUES
40.Fn SSL_set_bio
41cannot fail.
42.Sh SEE ALSO
43.Xr bio 3 ,
44.Xr ssl 3 ,
45.Xr SSL_accept 3 ,
46.Xr SSL_connect 3 ,
47.Xr SSL_get_rbio 3 ,
48.Xr SSL_shutdown 3