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