Consolidate doc of BIO_do_connect() and its alias BIO_do_handshake()

[thirdparty/openssl.git] / doc / man3 / BIO_s_connect.pod

diff --git a/doc/man3/BIO_s_connect.pod b/doc/man3/BIO_s_connect.pod
index 24f1120625336ee404a65f387af479d4e3366748..d5a909dcd24b2963b18dfe06f19f03f6d5521130 100644 (file)
--- a/doc/man3/BIO_s_connect.pod
+++ b/doc/man3/BIO_s_connect.pod
@@ -94,11 +94,16 @@ 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
-if the connection was established successfully. A zero or negative
-value is returned if the connection could not be established, the
-call BIO_should_retry() should be used for non blocking connect BIOs
+BIO_do_connect() attempts to connect the supplied BIO.
+This performs an SSL/TLS handshake as far as supported by the BIO.
+For non-SSL BIOs the connection is done typically at TCP level.
+If domain name resolution yields multiple IP addresses all of them are tried
+after connect() failures.
+The function returns 1 if the connection was established successfully.
+A zero or negative value is returned if the connection could not be established.
+The call BIO_should_retry() should be used for non blocking connect BIOs
 to determine if the call should be retried.
+If a connection has already been established this call has no effect.
 
 =head1 NOTES