X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=doc%2Fssl%2FSSL_connect.pod;h=68e2b82b8dbbb98ebb1b2dd1d0e4596947eb0cde;hp=92aa20e07974069ba1abb24207e606bbc033e400;hb=fd9e244370d13606182a144833a1d3244cff5b85;hpb=acb5b34328e0e65095f7924f58c78a146e3d8a93 diff --git a/doc/ssl/SSL_connect.pod b/doc/ssl/SSL_connect.pod index 92aa20e079..68e2b82b8d 100644 --- a/doc/ssl/SSL_connect.pod +++ b/doc/ssl/SSL_connect.pod @@ -12,17 +12,21 @@ SSL_connect - initiate the TLS/SSL handshake with an TLS/SSL server =head1 DESCRIPTION -SSL_connect() initiates the TLS handshake with a server. The communication +SSL_connect() initiates the TLS/SSL handshake with a server. The communication channel must already have been set and assigned to the B by setting an -underlying B. The behaviour of SSL_connect() depends on the underlying -BIO. +underlying B. + +=head1 NOTES + +The behaviour of SSL_connect() depends on the underlying BIO. If the underlying BIO is B, SSL_connect() will only return once the handshake has been finished or an error occurred. If the underlying BIO is B, SSL_connect() will also return when the underlying BIO could not satisfy the needs of SSL_connect() -to continue the handshake. In this case a call to SSL_get_error() with the +to continue the handshake, indicating the problem by the return value -1. +In this case a call to SSL_get_error() with the return value of SSL_connect() will yield B or B. The calling process then must repeat the call after taking appropriate action to satisfy the needs of SSL_connect(). @@ -37,18 +41,18 @@ The following return values can occur: =over 4 -=item 1 - -The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been -established. - -=item 0 +=item Z<>0 The TLS/SSL handshake was not successful but was shut down controlled and by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B to find out the reason. -=item -1 +=item Z<>1 + +The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been +established. + +=item E0 The TLS/SSL handshake was not successful, because a fatal error occurred either at the protocol level or a connection failure occurred. The shutdown was @@ -61,6 +65,9 @@ to find out the reason. =head1 SEE ALSO L, L, -L, L , L +L, L, L, +L, +L, +L =cut