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

=head1 NAME

U
Ulf Möller 已提交
5
SSL_set_fd - 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
U
Ulf Möller 已提交
23 24
inherit the behavior of B<fd>. If B<fd> is non-blocking, the B<ssl> will
also have non-blocking behavior.
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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

=head1 RETURN VALUES

The following return values can occur:

=over 4

=item 0

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

=item 1

The operation succeeded.

=back

=head1 SEE ALSO

L<SSL_get_fd(3)|SSL_get_fd(3)>, L<SSL_set_bio(3)|SSL_set_bio(3)>,
L<SSL_connect(3)|SSL_connect(3)>, L<SSL_accept(3)|SSL_accept(3)>,
L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)>

=cut