Remove -WX option from debug-VC-WIN32

[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 b8e25db22e3753a335a061d54129a807b616ca2e..1c8d3a91102745b581b284d2d8114945dab43a46 100644 (file)
--- a/doc/crypto/BIO_s_socket.pod
+++ b/doc/crypto/BIO_s_socket.pod
@@ -2,22 +2,22 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-BIO_s_socket - socket BIO
+BIO_s_socket, BIO_new_socket - socket BIO

 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
 
 
 =head1 SYNOPSIS
 
  #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);
 
 =head1 DESCRIPTION
 
 
  BIO *BIO_new_socket(int sock, int close_flag);
 
 =head1 DESCRIPTION
 

-BIO_f_socket() returns the socket BIO method. This is a wrapper
+BIO_s_socket() returns the socket BIO method. This is a wrapper

 round the platform's socket routines.
 
 BIO_read() and BIO_write() read or write the underlying socket.
 round the platform's socket routines.
 
 BIO_read() and BIO_write() read or write the underlying socket.


@@ -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,14 +44,16 @@ 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.
 
 BIO_set_fd() always returns 1.
 
 =head1 RETURN VALUES
 
 BIO_s_socket() returns the socket BIO method.
 
 BIO_set_fd() always returns 1.
 

-BIO_get_fd() returns the file descriptor or -1 if the BIO has not
-been initialised.
+BIO_get_fd() returns the socket or -1 if the BIO has not been
+initialized.

 
 BIO_new_socket() returns the newly allocated BIO or NULL is an error
 occurred.
 
 BIO_new_socket() returns the newly allocated BIO or NULL is an error
 occurred.