xref: /freebsd/crypto/openssl/doc/man3/SSL_get_rbio.pod (revision 525fe93dc7487a1e63a90f6a2b956abc601963c1)
1=pod
2
3=head1 NAME
4
5SSL_get_rbio, SSL_get_wbio - 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
16SSL_get_rbio() and SSL_get_wbio() return pointers to the BIOs for the
17read or the write channel, which can be different. The reference count
18of the BIO is not incremented.
19
20=head1 RETURN VALUES
21
22The following return values can occur:
23
24=over 4
25
26=item NULL
27
28No BIO was connected to the SSL object
29
30=item Any other pointer
31
32The BIO linked to B<ssl>.
33
34=back
35
36=head1 SEE ALSO
37
38L<SSL_set_bio(3)>, L<ssl(7)> , L<bio(7)>
39
40=head1 COPYRIGHT
41
42Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
43
44Licensed under the Apache License 2.0 (the "License").  You may not use
45this file except in compliance with the License.  You can obtain a copy
46in the file LICENSE in the source distribution or at
47L<https://www.openssl.org/source/license.html>.
48
49=cut
50