Blame doc/man3/SSL_set_fd.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
SSL_set_fd, SSL_set_rfd, SSL_set_wfd - connect the SSL object with a file descriptor
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 int SSL_set_fd(SSL *ssl, int fd);
Packit Service 084de1
 int SSL_set_rfd(SSL *ssl, int fd);
Packit Service 084de1
 int SSL_set_wfd(SSL *ssl, int fd);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL_set_fd() sets the file descriptor B<fd> as the input/output facility
Packit Service 084de1
for the TLS/SSL (encrypted) side of B<ssl>. B<fd> will typically be the
Packit Service 084de1
socket file descriptor of a network connection.
Packit Service 084de1
Packit Service 084de1
When performing the operation, a B<socket BIO> is automatically created to
Packit Service 084de1
interface between the B<ssl> and B<fd>. The BIO and hence the SSL engine
Packit Service 084de1
inherit the behaviour of B<fd>. If B<fd> is non-blocking, the B<ssl> will
Packit Service 084de1
also have non-blocking behaviour.
Packit Service 084de1
Packit Service 084de1
If there was already a BIO connected to B<ssl>, BIO_free() will be called
Packit Service 084de1
(for both the reading and writing side, if different).
Packit Service 084de1
Packit Service 084de1
SSL_set_rfd() and SSL_set_wfd() perform the respective action, but only
Packit Service 084de1
for the read channel or the write channel, which can be set independently.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
The following return values can occur:
Packit Service 084de1
Packit Service 084de1
=over 4
Packit Service 084de1
Packit Service 084de1
=item Z<>0
Packit Service 084de1
Packit Service 084de1
The operation failed. Check the error stack to find out why.
Packit Service 084de1
Packit Service 084de1
=item Z<>1
Packit Service 084de1
Packit Service 084de1
The operation succeeded.
Packit Service 084de1
Packit Service 084de1
=back
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<SSL_get_fd(3)>, L<SSL_set_bio(3)>,
Packit Service 084de1
L<SSL_connect(3)>, L<SSL_accept(3)>,
Packit Service 084de1
L<SSL_shutdown(3)>, L<ssl(7)> , L<bio(7)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut