generic-library/openssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

give pseudo prototypes instead of macro definitions for better clarity

Browse Source
This commit is contained in:
Ulf Möller 2000-10-19 22:02:21 +00:00
parent 11b62699a1
commit bbdc9c98a8
3 changed files with 42 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/crypto/BIO_s_accept.pod
View File

@ -10,31 +10,31 @@ BIO_get_bind_mode, BIO_do_accept - accept BIO
#include <openssl/bio.h> #include <openssl/bio.h>
BIO_METHOD * BIO_s_accept(void); BIO_METHOD *BIO_s_accept(void);
#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name) long BIO_set_accept_port(BIO *b, char *name);
#define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0) char *BIO_get_accept_port(BIO *b);
BIO *BIO_new_accept(char *host_port); BIO *BIO_new_accept(char *host_port);
#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?"a":NULL) long BIO_set_nbio_accept(BIO *b, int n);
#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio) long BIO_set_accept_bios(BIO *b, char *bio);
#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL) long BIO_set_bind_mode(BIO *b, long mode);
#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL) long BIO_get_bind_mode(BIO *b, long dummy);
#define BIO_BIND_NORMAL 0 #define BIO_BIND_NORMAL 0
#define BIO_BIND_REUSEADDR_IF_UNUSED 1 #define BIO_BIND_REUSEADDR_IF_UNUSED 1
#define BIO_BIND_REUSEADDR 2 #define BIO_BIND_REUSEADDR 2
#define BIO_do_accept(b) BIO_do_handshake(b) int BIO_do_accept(BIO *b);
=head1 DESCRIPTION =head1 DESCRIPTION
BIO_s_accept() returns the accept BIO method. This is a wrapper BIO_s_accept() returns the accept BIO method. This is a wrapper
round the platform's TCP/IP socket accept routines. round the platform's TCP/IP socket accept routines.
Using accept BIOs TCP/IP connections can be accepted and data Using accept BIOs, TCP/IP connections can be accepted and data
transferred using only BIO routines. In this way any platform transferred using only BIO routines. In this way any platform
specific operations are hidden by the BIO abstraction. specific operations are hidden by the BIO abstraction.
@ -130,13 +130,17 @@ however because the accept BIO will still accept additional incoming
connections. This can be resolved by using BIO_pop() (see above) connections. This can be resolved by using BIO_pop() (see above)
and freeing up the accept BIO after the initial connection. and freeing up the accept BIO after the initial connection.
If the underlying accept socket is non blocking and BIO_do_accept() is If the underlying accept socket is non-blocking and BIO_do_accept() is
called to await an incoming connection it is possible for called to await an incoming connection it is possible for
BIO_should_io_special() with the reason BIO_RR_ACCEPT. If this happens BIO_should_io_special() with the reason BIO_RR_ACCEPT. If this happens
then it is an indication that an accept attempt would block: the application then it is an indication that an accept attempt would block: the application
should take appropriate action to wait until the underlying socket has should take appropriate action to wait until the underlying socket has
accepted a connection and retry the call. accepted a connection and retry the call.
BIO_set_accept_port(), BIO_get_accept_port(), BIO_set_nbio_accept(),
BIO_set_accept_bios(), BIO_set_bind_mode(), BIO_get_bind_mode() and
BIO_do_accept() are macros.
=head1 RETURN VALUES =head1 RETURN VALUES
TBA TBA

34
doc/crypto/BIO_s_connect.pod
View File

@ -13,25 +13,27 @@ BIO_set_nbio, BIO_do_connect - connect BIO
BIO_METHOD * BIO_s_connect(void); BIO_METHOD * BIO_s_connect(void);
#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name) BIO *BIO_new_connect(char *name);
#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
#define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
#define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
#define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
#define BIO_get_conn_ip(b,ip) BIO_ptr_ctrl(b,BIO_C_SET_CONNECT,2)
#define BIO_get_conn_int_port(b,port) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,port)
#define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) long BIO_set_conn_hostname(BIO *b, char *name);
long BIO_set_conn_port(BIO *b, char *port);
long BIO_set_conn_ip(BIO *b, char *ip);
long BIO_set_conn_int_port(BIO *b, char *port);
char *BIO_get_conn_hostname(BIO *b);
char *BIO_get_conn_port(BIO *b);
char *BIO_get_conn_ip(BIO *b, dummy);
long BIO_get_conn_int_port(BIO *b, int port);
#define BIO_do_connect(b) BIO_do_handshake(b) long BIO_set_nbio(BIO *b, long n);
int BIO_do_connect(BIO *b);
=head1 DESCRIPTION =head1 DESCRIPTION
BIO_s_connect() returns the connect BIO method. This is a wrapper BIO_s_connect() returns the connect BIO method. This is a wrapper
round the platform's TCP/IP socket connection routines. round the platform's TCP/IP socket connection routines.
Using connect BIOs TCP/IP connections can be made and data Using connect BIOs, TCP/IP connections can be made and data
transferred using only BIO routines. In this way any platform transferred using only BIO routines. In this way any platform
specific operations are hidden by the BIO abstraction. specific operations are hidden by the BIO abstraction.
@ -54,7 +56,7 @@ BIO_get_fd() places the underlying socket in B<c> if it is not NULL,
it also returns the socket . If B<c> is not NULL it should be of it also returns the socket . If B<c> is not NULL it should be of
type (int *). type (int *).
BIO_set_conn_hostname() uses the string B<name> to set the hostname BIO_set_conn_hostname() uses the string B<name> to set the hostname.
The hostname can be an IP address. The hostname can also include the The hostname can be an IP address. The hostname can also include the
port in the form hostname:port . It is also acceptable to use the port in the form hostname:port . It is also acceptable to use the
form "hostname/any/other/path" or "hostname:port/any/other/path". form "hostname/any/other/path" or "hostname:port/any/other/path".
@ -87,6 +89,9 @@ is set. Blocking I/O is the default. The call to BIO_set_nbio()
should be made before the connection is established because should be made before the connection is established because
non blocking I/O is set during the connect process. non blocking I/O is set during the connect process.
BIO_new_connect() combines BIO_new() and BIO_set_conn_hostname() into
a single call: that is it creates a new connect BIO with B<name>.
BIO_do_connect() attempts to connect the supplied BIO. It returns 1 BIO_do_connect() attempts to connect the supplied BIO. It returns 1
if the connection was established successfully. A zero or negative if the connection was established successfully. A zero or negative
value is returned if the connection could not be established, the value is returned if the connection could not be established, the
@ -123,6 +128,11 @@ then this is an indication that a connection attempt would block,
the application should then take appropriate action to wait until the application should then take appropriate action to wait until
the underlying socket has connected and retry the call. the underlying socket has connected and retry the call.
BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip(),
BIO_set_conn_int_port(), BIO_get_conn_hostname(), BIO_get_conn_port(),
BIO_get_conn_ip(), BIO_get_conn_int_port(), BIO_set_nbio() and
BIO_do_connect() are macros.
=head1 RETURN VALUES =head1 RETURN VALUES
BIO_s_connect() returns the connect BIO method. BIO_s_connect() returns the connect BIO method.

10
doc/crypto/BIO_s_socket.pod
View File

@ -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) long BIO_set_fd(BIO *b, int fd, long close_flag);
#define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) 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,7 +27,7 @@ If the close flag is set then the socket is shut down and closed
when the BIO is freed. when the BIO is freed.
BIO_set_fd() sets the socket of BIO B<b> to B<fd> and the close 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 *).
@ -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 Windows is one such platform. Any code mixing the two will not work on
all platforms. all platforms.
BIO_set_fd() and BIO_get_fd() are macros.
=head1 RETURN VALUES =head1 RETURN VALUES
BIO_s_socket() returns the socket BIO method. BIO_s_socket() returns the socket BIO method.