Commit 88b8d83e authored by Vitezslav Cizek's avatar Vitezslav Cizek Committed by Ben Kaduk
Browse files

BIO_s_accept.pod: add documentation for the new macros 



Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
Reviewed-by: default avatarBen Kaduk <kaduk@mit.edu>
(Merged from https://github.com/openssl/openssl/pull/5007)
parent 2cb8445a

doc/man3/BIO_s_accept.pod

+15 −3
Original line number Diff line number Diff line
@@ -4,6 +4,8 @@ 


BIO_s_accept, BIO_set_accept_name, BIO_set_accept_port, BIO_get_accept_name,

BIO_get_accept_port, BIO_new_accept, BIO_set_nbio_accept, BIO_set_accept_bios,

BIO_get_peer_name, BIO_get_peer_port,

BIO_get_accept_ip_family, BIO_set_accept_ip_family,

BIO_set_bind_mode, BIO_get_bind_mode, BIO_do_accept - accept BIO



=head1 SYNOPSIS
@@ -23,6 +25,11 @@ BIO_set_bind_mode, BIO_get_bind_mode, BIO_do_accept - accept BIO 
 long BIO_set_nbio_accept(BIO *b, int n);

 long BIO_set_accept_bios(BIO *b, char *bio);



 char *BIO_get_peer_name(BIO *b);

 char *BIO_get_peer_port(BIO *b);

 long BIO_get_accept_ip_family(BIO *b);

 long BIO_set_accept_ip_family(BIO *b, long family);



 long BIO_set_bind_mode(BIO *b, long mode);

 long BIO_get_bind_mode(BIO *b);
@@ -145,18 +152,23 @@ accepted a connection and retry the call. 


BIO_set_accept_name(), BIO_get_accept_name(), BIO_set_accept_port(),

BIO_get_accept_port(), BIO_set_nbio_accept(), BIO_set_accept_bios(),

BIO_get_peer_name(), BIO_get_peer_port(),

BIO_get_accept_ip_family(), BIO_set_accept_ip_family(),

BIO_set_bind_mode(), BIO_get_bind_mode() and BIO_do_accept() are macros.



=head1 RETURN VALUES



BIO_do_accept(),

BIO_set_accept_name(), BIO_set_accept_port(), BIO_set_nbio_accept(),

BIO_set_accept_bios(), and BIO_set_bind_mode(), return 1 for success and 0 or

-1 for failure.

BIO_set_accept_bios(), BIO_set_accept_ip_family(), and BIO_set_bind_mode()

return 1 for success and 0 or -1 for failure.



BIO_get_accept_name() returns the accept name or NULL on error.

BIO_get_peer_name() returns the peer name or NULL on error.



BIO_get_accept_port() returns the port as a string or NULL on error.

BIO_get_accept_port() returns the accept port as a string or NULL on error.

BIO_get_peer_port() returns the peer port as a string or NULL on error.

BIO_get_accept_ip_family() returns the IP family or -1 on error.



BIO_get_bind_mode() returns the set of B<BIO_BIND> flags, or -1 on failure.

util/private.num

+4 −0
Original line number Diff line number Diff line
@@ -85,6 +85,9 @@ BIO_eof define 
BIO_flush                               define

BIO_get_accept_name                     define

BIO_get_accept_port                     define

BIO_get_accept_ip_family                define

BIO_get_peer_name                       define

BIO_get_peer_port                       define

BIO_get_bind_mode                       define

BIO_get_buffer_num_lines                define

BIO_get_cipher_ctx                      define
@@ -116,6 +119,7 @@ BIO_seek define 
BIO_set_accept_bios                     define

BIO_set_accept_name                     define

BIO_set_accept_port                     define

BIO_set_accept_ip_family                define

BIO_set_bind_mode                       define

BIO_set_buffer_read_data                define

BIO_set_buffer_size                     define