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