diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_rbio.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_get_rbio.3 | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_rbio.3 b/src/lib/libssl/doc/SSL_get_rbio.3 new file mode 100644 index 0000000000..a8370d5ef2 --- /dev/null +++ b/src/lib/libssl/doc/SSL_get_rbio.3 | |||
| @@ -0,0 +1,42 @@ | |||
| 1 | .Dd $Mdocdate: October 12 2014 $ | ||
| 2 | .Dt SSL_GET_RBIO 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm SSL_get_rbio , | ||
| 6 | .Nm SSL_get_wbio | ||
| 7 | .Nd get BIO linked to an SSL object | ||
| 8 | .Sh SYNOPSIS | ||
| 9 | .In openssl/ssl.h | ||
| 10 | .Ft BIO * | ||
| 11 | .Fn SSL_get_rbio "SSL *ssl" | ||
| 12 | .Ft BIO * | ||
| 13 | .Fn SSL_get_wbio "SSL *ssl" | ||
| 14 | .Sh DESCRIPTION | ||
| 15 | .Fn SSL_get_rbio | ||
| 16 | and | ||
| 17 | .Fn SSL_get_wbio | ||
| 18 | return pointers to the | ||
| 19 | .Vt BIO Ns s | ||
| 20 | for the read or the write channel, which can be different. | ||
| 21 | The reference count of the | ||
| 22 | .Vt BIO | ||
| 23 | is not incremented. | ||
| 24 | .Sh RETURN VALUES | ||
| 25 | The following return values can occur: | ||
| 26 | .Bl -tag -width Ds | ||
| 27 | .It Dv NULL | ||
| 28 | No | ||
| 29 | .Vt BIO | ||
| 30 | was connected to the | ||
| 31 | .Vt SSL | ||
| 32 | object. | ||
| 33 | .It Any other pointer | ||
| 34 | The | ||
| 35 | .Vt BIO | ||
| 36 | linked to | ||
| 37 | .Fa ssl . | ||
| 38 | .El | ||
| 39 | .Sh SEE ALSO | ||
| 40 | .Xr bio 3 , | ||
| 41 | .Xr ssl 3 , | ||
| 42 | .Xr SSL_set_bio 3 | ||
