diff options
author | Richard Levitte <levitte@openssl.org> | 2000-09-14 13:11:56 +0000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2000-09-14 13:11:56 +0000 |
commit | cc99526db1ee5b948736f6b07958a786fec1240b (patch) | |
tree | 24c07af7e38f014e2baa02ba5ce454e24d64211f /doc/ssl/SSL_get_fd.pod | |
parent | 72660f5f15fcd71215193f993dd95da0d130168a (diff) |
Add a number of documentation files, mostly for SSL routines, but also
for a few BIO routines.
Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc/ssl/SSL_get_fd.pod')
-rw-r--r-- | doc/ssl/SSL_get_fd.pod | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/ssl/SSL_get_fd.pod b/doc/ssl/SSL_get_fd.pod new file mode 100644 index 0000000000..0ed21d5f15 --- /dev/null +++ b/doc/ssl/SSL_get_fd.pod @@ -0,0 +1,44 @@ +=pod + +=head1 NAME + +SSL_get_fd - Get file descriptor linked to an SSL + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_get_fd(SSL *ssl); + int SSL_get_rfd(SSL *ssl); + int SSL_get_wfd(SSL *ssl); + +=head1 DESCRIPTION + +SSL_get_fd() returns the file descriptor which is linked to B<ssl>. +SSL_get_rfd() and SSL_get_wfd() return the file descriptors for the +read or the write channel, which can be different. If the read and the +write channel are different, SSL_get_fd() will return the file descriptor +of the read channel. + +=head1 RETURN VALUES + +The following return values can occur: + +=over 4 + +=item -1 + +The operation failed, because the underlying BIO is not of the correct type +(suitable for file descriptors). + +=item E<gt>=0 + +The file descriptor linked to B<ssl>. + +=back + +=head1 SEE ALSO + +L<SSL_set_fd(3)|SSL_set_fd(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)> + +=cut |