Clarification for SSL_ERROR_ZERO_RETURN

[openssl.git] / doc / ssl / SSL_get_error.pod

diff --git a/doc/ssl/SSL_get_error.pod b/doc/ssl/SSL_get_error.pod
index 26f7b3d3d08f5791bb5d64e294e8390e7b867cbe..7851830fc581847c2a101a766a265a0c25e09bd1 100644 (file)
--- a/doc/ssl/SSL_get_error.pod
+++ b/doc/ssl/SSL_get_error.pod
@@ -21,7 +21,7 @@ B<ret>.
 In addition to B<ssl> and B<ret>, SSL_get_error() inspects the
 current thread's OpenSSL error queue.  Thus, SSL_get_error() must be
 used in the same thread that performed the SSL I/O operation, and no
-other OpenSSL function calls should appear inbetween.  The current
+other OpenSSL function calls should appear in between.  The current
 thread's error queue must be empty before the SSL I/O operation is
 attempted, or SSL_get_error() will not work reliably.
 
@@ -34,14 +34,16 @@ The following return values can currently occur:
 =item SSL_ERROR_NONE
 
 The SSL I/O operation completed.  This result code is returned
-if and only if B<ret > 0>.
+if and only if B<ret E<gt> 0>.
 
 =item SSL_ERROR_ZERO_RETURN
 
 The SSL connection has been closed.  If the protocol version is SSL 3.0
 or TLS 1.0, this result code is returned only if a closure
-alerts has occured in the protocol, i.e. if the connection has been
-closed cleanly.
+alert has occurred in the protocol, i.e. if the connection has been
+closed cleanly. Note that in this case B<SSL_ERROR_ZERO_RETURN>
+does not necessarily indicate that the underlying transport
+has been closed.
 
 =item SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE
 
@@ -75,14 +77,14 @@ I/O error (for socket I/O on Unix systems, consult B<errno> for details).
 
 =item SSL_ERROR_SSL
 
-A failure in the SSL library occured, usually a protocol error.  The
+A failure in the SSL library occurred, usually a protocol error.  The
 OpenSSL error queue contains more information on the error.
 
 =back
 
 =head1 SEE ALSO
 
-ssl(3), err(3)
+L<ssl(3)|ssl(3)>, L<err(3)|err(3)>
 
 =head1 HISTORY