* Improve the documentation

Suggested by: jorton


git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@822431 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 8 insertions, 1 deletions

diff --git a/include/apr_network_io.h b/include/apr_network_io.h
index 43f881ac9..54d8f6e90 100644
--- a/include/apr_network_io.h
+++ b/include/apr_network_io.h
@@ -375,8 +375,15 @@ APR_DECLARE(apr_status_t) apr_socket_connect(apr_socket_t *sock,
                                              apr_sockaddr_t *sa);
 
 /**
- * Check whether the remote side of a socket is still open.
+ * Check whether the receive part of the socket has been shut down by the
+ * peer and that the socket's read buffer is empty. If this is true the next
+ * read on the socket wil return APR_EOF.
  * @param socket The socket to check
+ * @remark
+ * <PRE>
+ * This function does not block on the socket but returns immediately in
+ * any case.
+ * </PRE>
  */
 APR_DECLARE(int) apr_socket_is_connected(apr_socket_t *socket);