update documentation to reflect new renegotiation options
[openssl.git] / doc / ssl / SSL_get_rbio.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_rbio - get BIO linked to an SSL object
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  BIO *SSL_get_rbio(SSL *ssl);
12  BIO *SSL_get_wbio(SSL *ssl);
13
14 =head1 DESCRIPTION
15
16 SSL_get_rbio() and SSL_get_wbio() return pointers to the BIOs for the
17 read or the write channel, which can be different. The reference count
18 of the BIO is not incremented.
19
20 =head1 RETURN VALUES
21
22 The following return values can occur:
23
24 =over 4
25
26 =item NULL
27
28 No BIO was connected to the SSL object
29
30 =item Any other pointer
31
32 The BIO linked to B<ssl>.
33
34 =back
35
36 =head1 SEE ALSO
37
38 L<SSL_set_bio(3)|SSL_set_bio(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)>
39
40 =cut