apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rpl...@apache.org
Subject svn commit: r822431 - /apr/apr/trunk/include/apr_network_io.h
Date Tue, 06 Oct 2009 19:01:45 GMT
Author: rpluem
Date: Tue Oct  6 19:01:45 2009
New Revision: 822431

URL: http://svn.apache.org/viewvc?rev=822431&view=rev
Log:
* Improve the documentation

Suggested by: jorton

Modified:
    apr/apr/trunk/include/apr_network_io.h

Modified: apr/apr/trunk/include/apr_network_io.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_network_io.h?rev=822431&r1=822430&r2=822431&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_network_io.h (original)
+++ apr/apr/trunk/include/apr_network_io.h Tue Oct  6 19:01:45 2009
@@ -375,8 +375,15 @@
                                              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);
 



Mime
View raw message