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

[tr...@apache.org]

Author: trawick
Date: Thu Jan 15 04:15:52 2009
New Revision: 734680

URL: http://svn.apache.org/viewvc?rev=734680&view=rev
Log:
standardize the description of the timeout parameter on different poll APIs
(a couple of them didn't describe negative timeouts)

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=734680&r1=734679&r2=734680&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_poll.h (original)
+++ apr/apr/trunk/include/apr_poll.h Thu Jan 15 04:15:52 2009
@@ -164,7 +164,10 @@
 /**
  * Block for activity on the descriptor(s) in a pollset
  * @param pollset The pollset to use
- * @param timeout Timeout in microseconds
+ * @param timeout The amount of time in microseconds to wait.  This is 
+ *                a maximum, not a minimum.  If a descriptor is signalled, we 
+ *                will wake up before this time.  A negative number means 
+ *                wait until a descriptor is signalled.
  * @param num Number of signalled descriptors (output parameter)
  * @param descriptors Array of signalled descriptors (output parameter)
  * @remark If the pollset has been created with APR_POLLSET_WAKEABLE
@@ -254,7 +257,10 @@
 /**
  * Block for activity on the descriptor(s) in a pollcb
  * @param pollcb The pollcb to use
- * @param timeout Timeout in microseconds
+ * @param timeout The amount of time in microseconds to wait.  This is 
+ *                a maximum, not a minimum.  If a descriptor is signalled, we 
+ *                will wake up before this time.  A negative number means 
+ *                wait until a descriptor is signalled.
  * @param func Callback function to call for each active socket
  * @param baton Opaque baton passed to the callback function.
  */