mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-01-30 14:01:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update the BIO_s_connect documentation after the BIO refactoring.

Browse Source 
The BIO was refactored in 417be660e1,
but the manual wasn't fully updated to reflect some of the changes.

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Ben Kaduk <kaduk@mit.edu>
(Merged from https://github.com/openssl/openssl/pull/5007)
This commit is contained in:
Vitezslav Cizek 2018-01-02 14:43:18 +01:00 committed by Ben Kaduk
parent f2633200eb
commit 0f1c0cf154
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/man3/BIO_s_connect.pod
View File

@ -107,10 +107,10 @@ ports. This can be avoided by checking for the presence of the ':'
character in the passed hostname and either indicating an error or character in the passed hostname and either indicating an error or
truncating the string at that point. truncating the string at that point.
The values returned by BIO_get_conn_hostname(), BIO_get_conn_port(), The values returned by BIO_get_conn_hostname(), BIO_get_conn_address(),
BIO_get_conn_ip() and BIO_get_conn_int_port() are updated when a and BIO_get_conn_port() are updated when a connection attempt is made.
connection attempt is made. Before any connection attempt the values Before any connection attempt the values returned are those set by the
returned are those set by the application itself. application itself.
Applications do not have to call BIO_do_connect() but may wish to do Applications do not have to call BIO_do_connect() but may wish to do
so to separate the connection process from other I/O processing. so to separate the connection process from other I/O processing.
@ -124,10 +124,9 @@ 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_hostname(), BIO_set_conn_port(), BIO_get_conn_hostname(),
BIO_set_conn_int_port(), BIO_get_conn_hostname(), BIO_get_conn_port(), BIO_set_conn_address(), BIO_get_conn_port(), BIO_get_conn_address(),
BIO_get_conn_ip(), BIO_get_conn_int_port(), BIO_set_nbio() and BIO_set_nbio(), and BIO_do_connect() are macros.
BIO_do_connect() are macros.
=head1 RETURN VALUES =head1 RETURN VALUES
@ -136,21 +135,19 @@ BIO_s_connect() returns the connect BIO method.
BIO_get_fd() returns the socket or -1 if the BIO has not BIO_get_fd() returns the socket or -1 if the BIO has not
been initialized. been initialized.
BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip() and BIO_set_conn_address() and BIO_set_conn_port() always return 1.
BIO_set_conn_int_port() always return 1.
BIO_get_conn_hostname() returns the connected hostname or NULL is BIO_set_conn_hostname() returns 1 on success and 0 on failure.
BIO_get_conn_address() returns the address information or NULL if none
was set.
BIO_get_conn_hostname() returns the connected hostname or NULL if
none was set. none was set.
BIO_get_conn_port() returns a string representing the connected BIO_get_conn_port() returns a string representing the connected
port or NULL if not set. port or NULL if not set.
BIO_get_conn_ip() returns a pointer to the connected IP address in
binary form or all zeros if not set.
BIO_get_conn_int_port() returns the connected port or 0 if none was
set.
BIO_set_nbio() always returns 1. BIO_set_nbio() always returns 1.
BIO_do_connect() returns 1 if the connection was successfully BIO_do_connect() returns 1 if the connection was successfully
@ -188,6 +185,12 @@ to retrieve a page and copy the result to standard output.
L<BIO_ADDR(3)> L<BIO_ADDR(3)>
=head1 HISTORY
BIO_set_conn_int_port(), BIO_get_conn_int_port(), BIO_set_conn_ip(), and BIO_get_conn_ip()
were removed in OpenSSL 1.1.0.
Use BIO_set_conn_address() and BIO_get_conn_address() instead.
=head1 COPYRIGHT =head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.