SemaphoreSet.st
changeset 24357 cd704e0c423f
parent 24197 521267ef7b16
--- a/SemaphoreSet.st	Tue Jun 25 10:48:39 2019 +0200
+++ b/SemaphoreSet.st	Tue Jun 25 14:22:02 2019 +0200
@@ -222,7 +222,14 @@
 
 waitWithTimeout:secondsOrNilOrTimeDuration
     "wait for any of the semaphore, but abort the wait after some time (seconds).
-     Return the (first) triggered semaphore if any, nil if we return due to a timeout."
+     Return the (first) triggered semaphore if any, nil if we return due to a timeout.
+     
+     The argument may be a time duration or the number of seconds as integer
+     or float (i.e. use 0.1 for a 100ms timeout).
+     With zero timeout, this can be used to poll a semaphore (returning
+     the receiver if the semaphore is available, nil if not).
+     However, polling is not the intended use of semaphores, though.
+     If the argument is nil, wait without timeout (forever)."
 
     |millis|
 
@@ -239,6 +246,7 @@
     "Modified: / 20-08-1997 / 18:33:23 / cg"
     "Modified: / 21-02-2017 / 14:48:48 / stefan"
     "Modified: / 27-05-2019 / 21:45:55 / Stefan Vogel"
+    "Modified (comment): / 25-06-2019 / 14:21:40 / Claus Gittinger"
 !
 
 waitWithTimeoutMs:milliSeconds