summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjamercee <jim@carroll.com>2016-08-03 11:31:46 -0400
committerRich Salz <rsalz@openssl.org>2016-08-10 11:07:42 -0400
commitb4c1d72e9f4fd47581d2231906b9d45bc003cb3b (patch)
treece032f926a87baa023054e04887eb2179b8a87bc /doc
parent2301d91dd58d9827865e360d616291f2549ec5bf (diff)
Adapt BIO_new_accept() to call BIO_set_accept_name()
Commit 417be66 broken BIO_new_accept() by changing the definition of the macro BIO_set_accept_port() which stopped acpt_ctrl() from calling BIO_parse_hostserv(). This commit completes the series of changes initiated in 417be66. Updated pods to reflect new definition introduced by 417be66. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1386)
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/BIO_s_accept.pod31
1 files changed, 18 insertions, 13 deletions
diff --git a/doc/crypto/BIO_s_accept.pod b/doc/crypto/BIO_s_accept.pod
index 724f1480df..174bd73ce1 100644
--- a/doc/crypto/BIO_s_accept.pod
+++ b/doc/crypto/BIO_s_accept.pod
@@ -2,9 +2,9 @@
=head1 NAME
-BIO_s_accept, BIO_set_accept_port, BIO_get_accept_port, BIO_new_accept,
-BIO_set_nbio_accept, BIO_set_accept_bios, BIO_set_bind_mode,
-BIO_get_bind_mode, BIO_do_accept - accept BIO
+BIO_s_accept, BIO_set_accept_name, BIO_get_name, BIO_set_accept_port,
+BIO_get_accept_port, BIO_new_accept, BIO_set_nbio_accept, BIO_set_accept_bios,
+BIO_set_bind_mode, BIO_get_bind_mode, BIO_do_accept - accept BIO
=head1 SYNOPSIS
@@ -12,6 +12,9 @@ BIO_get_bind_mode, BIO_do_accept - accept BIO
const BIO_METHOD *BIO_s_accept(void);
+ long BIO_set_accept_name(BIO *b, char *name);
+ char *BIO_get_accept_name(BIO *b);
+
long BIO_set_accept_port(BIO *b, char *name);
char *BIO_get_accept_port(BIO *b);
@@ -52,17 +55,17 @@ incoming connection.
BIO_get_fd() and BIO_set_fd() can be called to retrieve or set
the accept socket. See L<BIO_s_fd(3)>
-BIO_set_accept_port() uses the string B<name> to set the accept
-port. The port is represented as a string of the form "host:port",
+BIO_set_accept_name() uses the string B<name> to set the accept
+name. The name is represented as a string of the form "host:port",
where "host" is the interface to use and "port" is the port.
The host can be "*" or empty which is interpreted as meaning
any interface. If the host is an IPv6 address, it has to be
enclosed in brackets, for example "[::1]:https". "port" has the
-same syntax as the port specified in BIO_set_conn_port() for
+same syntax as the port specified in BIO_set_conn_name() for
connect BIOs, that is it can be a numerical port string or a
string to lookup using getservbyname() and a string table.
-BIO_new_accept() combines BIO_new() and BIO_set_accept_port() into
+BIO_new_accept() combines BIO_new() and BIO_set_accept_name() into
a single call: that is it creates a new accept BIO with port
B<host_port>.
@@ -134,17 +137,19 @@ then it is an indication that an accept attempt would block: the application
should take appropriate action to wait until the underlying socket has
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.
+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_set_bind_mode(), BIO_get_bind_mode() and BIO_do_accept() are macros.
=head1 RETURN VALUES
BIO_do_accept(),
-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_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_get_accept_port() returns the port name or NULL on error.
+BIO_set_accept_name() and BIO_get_accept_port() returns the port name or NULL
+on error.
BIO_get_bind_mode() returns the set of B<BIO_BIND> flags, or -1 on failure.