Changeset 7:a3d84407fb9a in xplcommon for src/xplcommon/WaitableEvent.h

Timestamp:

12/29/12 07:45:57 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added the public interfaces

File:

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

src/xplcommon/WaitableEvent.h

@@ -30 +30 @@
 #ifndef XPLCOMMON_WAITABLEEVENT_H
 #define XPLCOMMON_WAITABLEEVENT_H
+//------------------------------------------------------------------------------
+
+// The public interface of the WaitableEvent class common to all platforms
+#if 0
+
+//------------------------------------------------------------------------------
+
+namespace xplcommon {
+
+//------------------------------------------------------------------------------
+
+/**
+ * An event on which one can wait with a waiter.
+ */
+class WaitableEvent : public Waitable
+{
+public:
+    /**
+     * Construct the event.
+     */
+    WaitableEvent(Waiter* waiter = 0);
+
+    /**
+     * Destroy the event.
+     */
+    virtual ~WaitableEvent();
+
+    /**
+     * Fire the event.
+     */
+    void fire();
+
+    /**
+     * Check if the event is fired or not. If so, the fired status
+     * will be cleared.
+     */
+    bool check();
+};
+
+//------------------------------------------------------------------------------
+
+} /* namespace xplcommon */
+
+//------------------------------------------------------------------------------
+
+#endif // 0, // The public interface of the WaitableEvent class common to all platforms
+
 //------------------------------------------------------------------------------