More CMS API documentation.

[oweals/openssl.git] / doc / crypto / BIO_s_socket.pod

diff --git a/doc/crypto/BIO_s_socket.pod b/doc/crypto/BIO_s_socket.pod
index 253185185c7f1b87e7ee683507c48cddd0eec3bc..1c8d3a91102745b581b284d2d8114945dab43a46 100644 (file)
--- 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>
 
 
  #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);
 
 
  BIO *BIO_new_socket(int sock, int close_flag);
 


@@ -27,10 +27,10 @@ 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
 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
 
 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 *).
+returns the socket. If B<c> is not NULL it should be of type (int *).

 
 BIO_new_socket() returns a socket BIO using B<sock> and B<close_flag>.
 
 
 BIO_new_socket() returns a socket BIO using B<sock> and B<close_flag>.
 


@@ -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.
 
 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.
 =head1 RETURN VALUES
 
 BIO_s_socket() returns the socket BIO method.