SSL_set_fd.pod 1.6 KB
Newer Older
1 2 3 4
=pod

=head1 NAME

M
Matt Caswell 已提交
5
SSL_set_fd, SSL_set_rfd, SSL_set_wfd - connect the SSL object with a file descriptor
6 7 8 9 10 11 12 13 14 15 16 17

=head1 SYNOPSIS

 #include <openssl/ssl.h>

 int SSL_set_fd(SSL *ssl, int fd);
 int SSL_set_rfd(SSL *ssl, int fd);
 int SSL_set_wfd(SSL *ssl, int fd);

=head1 DESCRIPTION

SSL_set_fd() sets the file descriptor B<fd> as the input/output facility
U
Ulf Möller 已提交
18
for the TLS/SSL (encrypted) side of B<ssl>. B<fd> will typically be the
19 20 21 22
socket file descriptor of a network connection.

When performing the operation, a B<socket BIO> is automatically created to
interface between the B<ssl> and B<fd>. The BIO and hence the SSL engine
23 24
inherit the behaviour of B<fd>. If B<fd> is non-blocking, the B<ssl> will
also have non-blocking behaviour.
25 26 27 28

If there was already a BIO connected to B<ssl>, BIO_free() will be called
(for both the reading and writing side, if different).

U
Ulf Möller 已提交
29 30
SSL_set_rfd() and SSL_set_wfd() perform the respective action, but only
for the read channel or the write channel, which can be set independently.
31 32 33 34 35 36 37

=head1 RETURN VALUES

The following return values can occur:

=over 4

L
Lubomir Rintel 已提交
38
=item Z<>0
39 40 41

The operation failed. Check the error stack to find out why.

L
Lubomir Rintel 已提交
42
=item Z<>1
43 44 45 46 47 48 49

The operation succeeded.

=back

=head1 SEE ALSO

R
Rich Salz 已提交
50 51 52
L<SSL_get_fd(3)>, L<SSL_set_bio(3)>,
L<SSL_connect(3)>, L<SSL_accept(3)>,
L<SSL_shutdown(3)>, L<ssl(3)> , L<bio(3)>
53 54

=cut
R
Rich Salz 已提交
55 56 57 58 59 60 61 62 63 64 65

=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