svn commit: r748892 - /apr/apr/trunk/include/apr_poll.h

[tr...@apache.org]

Author: trawick
Date: Sat Feb 28 17:40:10 2009
New Revision: 748892

URL: http://svn.apache.org/viewvc?rev=748892&view=rev
Log:
Document the restriction that you can't (successfully) add the same socket or
file to the same pollset.

(At present, two of the n implementations will let you do it, but the subsequent
results from a poll operation can differ from when add the socket/file once
with all necessary request events.)

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

Modified: apr/apr/trunk/include/apr_poll.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_poll.h?rev=748892&r1=748891&r2=748892&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_poll.h (original)
+++ apr/apr/trunk/include/apr_poll.h Sat Feb 28 17:40:10 2009
@@ -200,6 +200,12 @@
  * @remark If the pollset has been created with APR_POLLSET_NOCOPY, the 
  *         apr_pollfd_t structure referenced by descriptor will not be copied
  *         and must have a lifetime at least as long as the pollset.
+ * @remark Do not add the same socket or file descriptor to the same pollset
+ *         multiple times, even if the requested events differ for the 
+ *         different calls to apr_pollset_add().  If the events of interest
+ *         for a descriptor change, you must first remove the descriptor 
+ *         from the pollset with apr_pollset_remove(), then add it again 
+ *         specifying all requested events.
  */
 APR_DECLARE(apr_status_t) apr_pollset_add(apr_pollset_t *pollset,
                                           const apr_pollfd_t *descriptor);