SSL_get_fd.pod 889 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. =pod
  2. =head1 NAME
  3. SSL_get_fd - get file descriptor linked to an SSL object
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. int SSL_get_fd(const SSL *ssl);
  7. int SSL_get_rfd(const SSL *ssl);
  8. int SSL_get_wfd(const SSL *ssl);
  9. =head1 DESCRIPTION
  10. SSL_get_fd() returns the file descriptor which is linked to B<ssl>.
  11. SSL_get_rfd() and SSL_get_wfd() return the file descriptors for the
  12. read or the write channel, which can be different. If the read and the
  13. write channel are different, SSL_get_fd() will return the file descriptor
  14. of the read channel.
  15. =head1 RETURN VALUES
  16. The following return values can occur:
  17. =over 4
  18. =item -1
  19. The operation failed, because the underlying BIO is not of the correct type
  20. (suitable for file descriptors).
  21. =item E<gt>=0
  22. The file descriptor linked to B<ssl>.
  23. =back
  24. =head1 SEE ALSO
  25. L<SSL_set_fd(3)|SSL_set_fd(3)>, L<ssl(3)|ssl(3)> , L<bio(3)|bio(3)>
  26. =cut