summaryrefslogtreecommitdiffstats
path: root/doc/crypto/BIO_s_socket.pod
diff options
context:
space:
mode:
authorUlf Möller <ulf@openssl.org>2000-10-19 22:02:21 +0000
committerUlf Möller <ulf@openssl.org>2000-10-19 22:02:21 +0000
commitbbdc9c98a81dc6677684fc7faa4a52414d28ef5a (patch)
tree9489a54e0d6fece868c90ad12ba703d24676126f /doc/crypto/BIO_s_socket.pod
parent11b62699a1f707b55747a34764d62be8be881b52 (diff)
give pseudo prototypes instead of macro definitions for better clarity
Diffstat (limited to 'doc/crypto/BIO_s_socket.pod')
-rw-r--r--doc/crypto/BIO_s_socket.pod10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/crypto/BIO_s_socket.pod b/doc/crypto/BIO_s_socket.pod
index 92b6448e33..1c8d3a9110 100644
--- a/doc/crypto/BIO_s_socket.pod
+++ b/doc/crypto/BIO_s_socket.pod
@@ -8,10 +8,10 @@ BIO_s_socket, BIO_new_socket - socket BIO
#include <openssl/bio.h>
- BIO_METHOD * BIO_s_socket(void);
+ BIO_METHOD *BIO_s_socket(void);
- #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
- #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
+ long BIO_set_fd(BIO *b, int fd, long close_flag);
+ long BIO_get_fd(BIO *b, int *c);
BIO *BIO_new_socket(int sock, int close_flag);
@@ -27,7 +27,7 @@ If the close flag is set then the socket is shut down and closed
when the BIO is freed.
BIO_set_fd() sets the socket of BIO B<b> to B<fd> and the close
-flag to B<c>.
+flag to B<close_flag>.
BIO_get_fd() places the socket in B<c> if it is not NULL, it also
returns the socket. If B<c> is not NULL it should be of type (int *).
@@ -44,6 +44,8 @@ platforms sockets are not file descriptors and use distinct I/O routines,
Windows is one such platform. Any code mixing the two will not work on
all platforms.
+BIO_set_fd() and BIO_get_fd() are macros.
+
=head1 RETURN VALUES
BIO_s_socket() returns the socket BIO method.