← Back to branch summary

~brian-sidebotham/openssl-cmake/1.0.1e

« back to all changes in this revision

Viewing changes to doc/ssl/SSL_set_fd.pod

  • Committer: Brian Sidebotham
  • Date: 2013-10-19 21:50:27 UTC
  • Revision ID: brian.sidebotham@gmail.com-20131019215027-yzoyh4svqj87uepu
Import OpenSSL 1.0.1e

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/ssl/SSL_set_fd.pod
 
1
=pod
 
2
 
 
3
=head1 NAME
 
4
 
 
5
SSL_set_fd - connect the SSL object with a file descriptor
 
6
 
 
7
=head1 SYNOPSIS
 
8
 
 
9
 #include <openssl/ssl.h>
 
10
 
 
11
 int SSL_set_fd(SSL *ssl, int fd);
 
12
 int SSL_set_rfd(SSL *ssl, int fd);
 
13
 int SSL_set_wfd(SSL *ssl, int fd);
 
14
 
 
15
=head1 DESCRIPTION
 
16
 
 
17
SSL_set_fd() sets the file descriptor B<fd> as the input/output facility
 
18
for the TLS/SSL (encrypted) side of B<ssl>. B<fd> will typically be the
 
19
socket file descriptor of a network connection.
 
20
 
 
21
When performing the operation, a B<socket BIO> is automatically created to
 
22
interface between the B<ssl> and B<fd>. The BIO and hence the SSL engine
 
23
inherit the behaviour of B<fd>. If B<fd> is non-blocking, the B<ssl> will
 
24
also have non-blocking behaviour.
 
25
 
 
26
If there was already a BIO connected to B<ssl>, BIO_free() will be called
 
27
(for both the reading and writing side, if different).
 
28
 
 
29
SSL_set_rfd() and SSL_set_wfd() perform the respective action, but only
 
30
for the read channel or the write channel, which can be set independently.
 
31
 
 
32
=head1 RETURN VALUES
 
33
 
 
34
The following return values can occur:
 
35
 
 
36
=over 4
 
37
 
 
38
=item 0
 
39
 
 
40
The operation failed. Check the error stack to find out why.
 
41
 
 
42
=item 1
 
43
 
 
44
The operation succeeded.
 
45
 
 
46
=back
 
47
 
 
48
=head1 SEE ALSO
 
49
 
 
50
L<SSL_get_fd(3)|SSL_get_fd(3)>, L<SSL_set_bio(3)|SSL_set_bio(3)>,
 
51
L<SSL_connect(3)|SSL_connect(3)>, L<SSL_accept(3)|SSL_accept(3)>,
 
52
L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)>
 
53
 
 
54
=cut