xref: /onnv-gate/usr/src/common/openssl/doc/ssl/SSL_get_rbio.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948SSL_get_rbio - get BIO linked to an SSL object
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/ssl.h>
10*2175Sjp161948
11*2175Sjp161948 BIO *SSL_get_rbio(SSL *ssl);
12*2175Sjp161948 BIO *SSL_get_wbio(SSL *ssl);
13*2175Sjp161948
14*2175Sjp161948=head1 DESCRIPTION
15*2175Sjp161948
16*2175Sjp161948SSL_get_rbio() and SSL_get_wbio() return pointers to the BIOs for the
17*2175Sjp161948read or the write channel, which can be different. The reference count
18*2175Sjp161948of the BIO is not incremented.
19*2175Sjp161948
20*2175Sjp161948=head1 RETURN VALUES
21*2175Sjp161948
22*2175Sjp161948The following return values can occur:
23*2175Sjp161948
24*2175Sjp161948=over 4
25*2175Sjp161948
26*2175Sjp161948=item NULL
27*2175Sjp161948
28*2175Sjp161948No BIO was connected to the SSL object
29*2175Sjp161948
30*2175Sjp161948=item Any other pointer
31*2175Sjp161948
32*2175Sjp161948The BIO linked to B<ssl>.
33*2175Sjp161948
34*2175Sjp161948=back
35*2175Sjp161948
36*2175Sjp161948=head1 SEE ALSO
37*2175Sjp161948
38*2175Sjp161948L<SSL_set_bio(3)|SSL_set_bio(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)>
39*2175Sjp161948
40*2175Sjp161948=cut
41