svn commit: r736309 - /apr/apr/branches/1.3.x/include/apr_poll.h

[tr...@apache.org]

Author: trawick
Date: Wed Jan 21 05:42:33 2009
New Revision: 736309

URL: http://svn.apache.org/viewvc?rev=736309&view=rev
Log:
Merge r734680 from trunk:

standardize the description of the timeout parameter on different poll APIs
(a couple of them didn't describe negative timeouts)

Modified:
    apr/apr/branches/1.3.x/include/apr_poll.h

Modified: apr/apr/branches/1.3.x/include/apr_poll.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.3.x/include/apr_poll.h?rev=736309&r1=736308&r2=736309&view=diff
==============================================================================
--- apr/apr/branches/1.3.x/include/apr_poll.h (original)
+++ apr/apr/branches/1.3.x/include/apr_poll.h Wed Jan 21 05:42:33 2009
@@ -157,7 +157,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)
  */
@@ -236,7 +239,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.
  */