Changeset 8:dba41f33ddce in xplcommon for src/xplcommon/WaitableEvent.h

Timestamp:

12/29/12 08:01:50 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Clarified the blocking and non-blocking behaviour and extended the test program to test both

File:

• src/xplcommon/WaitableEvent.h (modified) (1 diff)

src/xplcommon/WaitableEvent.h

@@ -44 +44 @@
  * An event on which one can wait with a waiter.
  */
-class WaitableEvent : public Waitable
+class WaitableEvent : public Waitable, public Failable
 {
 public:
     /**
      * Construct the event.
+     *
+     * @param waiter the waiter to be used for waiting. If given, the
+     * check() function will always return immediately. If not given,
+     * the check() function may block and returns only when the event
+     * is fired.
      */
     WaitableEvent(Waiter* waiter = 0);