Correction from Tani Hosokawa <unknown@riverstyx.net>
[openssl.git] / doc / ssl / SSL_set_bio.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_set_bio - connect the SSL object with a BIO
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
12
13 =head1 DESCRIPTION
14
15 SSL_set_bio() connects the BIOs B<rbio> and B<wbio> for the read and write
16 operations of the TLS/SSL (encrypted) side of B<ssl>.
17
18 The SSL engine inherits the behaviour of B<rbio> and B<wbio>, respectively.
19 If a BIO is non-blocking, the B<ssl> will also have non-blocking behaviour.
20
21 If there was already a BIO connected to B<ssl>, BIO_free() will be called
22 (for both the reading and writing side, if different).
23
24 =head1 RETURN VALUES
25
26 SSL_set_bio() cannot fail.
27
28 =head1 SEE ALSO
29
30 L<SSL_get_rbio(3)|SSL_get_rbio(3)>,
31 L<SSL_connect(3)|SSL_connect(3)>, L<SSL_accept(3)|SSL_accept(3)>,
32 L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>
33
34 =cut