projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| cc99526d RL |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| aafbe1cc | 5 | SSL_get_rbio, SSL_get_wbio - get BIO linked to an SSL object |
| cc99526d RL |
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 | ||
| 1e4e5492 | 28 | No BIO was connected to the SSL object |
| cc99526d RL |
29 | |
| 30 | =item Any other pointer | |
| 31 | ||
| 32 | The BIO linked to B<ssl>. | |
| 33 | ||
| 34 | =back | |
| 35 | ||
| 36 | =head1 SEE ALSO | |
| 37 | ||
| b97fdb57 | 38 | L<SSL_set_bio(3)>, L<ssl(7)> , L<bio(7)> |
| cc99526d | 39 | |
| e2f92610 RS |
40 | =head1 COPYRIGHT |
| 41 | ||
| 42 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 43 | ||
| 44 | Licensed under the OpenSSL license (the "License"). You may not use | |
| 45 | this file except in compliance with the License. You can obtain a copy | |
| 46 | in the file LICENSE in the source distribution or at | |
| 47 | L<https://www.openssl.org/source/license.html>. | |
| 48 | ||
| 49 | =cut |