mirror of
https://github.com/openssl/openssl.git
synced 2024-11-27 05:21:51 +08:00
c952780c25
Add missing entries to NAME section Add SYNOPSIS lines, remove old NAME entries Update find-doc-nits; better regexp's for parsing SYNOPSIS sections. Rename a couple of files to have an API name. Remove RSA_private_decrypt; it was duplicate content Update for recent doc additions Reviewed-by: Matt Caswell <matt@openssl.org>
55 lines
1.5 KiB
Plaintext
55 lines
1.5 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL_set_bio, SSL_set_rbio, SSL_set_wbio - connect the SSL object with a BIO
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
|
|
void SSL_set_rbio(SSL *s, BIO *rbio);
|
|
void SSL_set_wbio(SSL *s, BIO *wbio);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
SSL_set_bio() connects the BIOs B<rbio> and B<wbio> for the read and write
|
|
operations of the TLS/SSL (encrypted) side of B<ssl>.
|
|
|
|
The SSL engine inherits the behaviour of B<rbio> and B<wbio>, respectively.
|
|
If a BIO is non-blocking, the B<ssl> will also have non-blocking behaviour.
|
|
|
|
If there was already a BIO connected to B<ssl>, BIO_free() will be called
|
|
(for both the reading and writing side, if different).
|
|
|
|
SSL_set_rbio() does the same job as SSL_set_bio() except that it enables you
|
|
to only connect the read bio, without touching the write bio. Similarly
|
|
SSL_set_wbio() enables you to connect the write bio without touching the read
|
|
bio.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
SSL_set_bio(), SSL_set_rbio() and SSL_set_wbio() cannot fail.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<SSL_get_rbio(3)>,
|
|
L<SSL_connect(3)>, L<SSL_accept(3)>,
|
|
L<SSL_shutdown(3)>, L<ssl(3)>, L<bio(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
SSL_set_rbio() and SSL_set_wbio() were added in OpenSSL 1.1.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|