xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man3/SSL_get_rbio.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosSSL_get_rbio, SSL_get_wbio - get BIO linked to an SSL object
6*4724848cSchristos
7*4724848cSchristos=head1 SYNOPSIS
8*4724848cSchristos
9*4724848cSchristos #include <openssl/ssl.h>
10*4724848cSchristos
11*4724848cSchristos BIO *SSL_get_rbio(SSL *ssl);
12*4724848cSchristos BIO *SSL_get_wbio(SSL *ssl);
13*4724848cSchristos
14*4724848cSchristos=head1 DESCRIPTION
15*4724848cSchristos
16*4724848cSchristosSSL_get_rbio() and SSL_get_wbio() return pointers to the BIOs for the
17*4724848cSchristosread or the write channel, which can be different. The reference count
18*4724848cSchristosof the BIO is not incremented.
19*4724848cSchristos
20*4724848cSchristos=head1 RETURN VALUES
21*4724848cSchristos
22*4724848cSchristosThe following return values can occur:
23*4724848cSchristos
24*4724848cSchristos=over 4
25*4724848cSchristos
26*4724848cSchristos=item NULL
27*4724848cSchristos
28*4724848cSchristosNo BIO was connected to the SSL object
29*4724848cSchristos
30*4724848cSchristos=item Any other pointer
31*4724848cSchristos
32*4724848cSchristosThe BIO linked to B<ssl>.
33*4724848cSchristos
34*4724848cSchristos=back
35*4724848cSchristos
36*4724848cSchristos=head1 SEE ALSO
37*4724848cSchristos
38*4724848cSchristosL<SSL_set_bio(3)>, L<ssl(7)> , L<bio(7)>
39*4724848cSchristos
40*4724848cSchristos=head1 COPYRIGHT
41*4724848cSchristos
42*4724848cSchristosCopyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
43*4724848cSchristos
44*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
45*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
46*4724848cSchristosin the file LICENSE in the source distribution or at
47*4724848cSchristosL<https://www.openssl.org/source/license.html>.
48*4724848cSchristos
49*4724848cSchristos=cut
50