Changeset 7:a3d84407fb9a in xplcommon for src/xplcommon/Waiter.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/Waiter.h (modified) (1 diff)

src/xplcommon/Waiter.h

@@ -30 +30 @@
 #ifndef XPLCOMMON_WAITER_H
 #define XPLCOMMON_WAITER_H
+//------------------------------------------------------------------------------
+
+// The public interface of the Waiter class common to all platforms
+#if 0
+
+//------------------------------------------------------------------------------
+
+namespace xplcommon {
+
+//------------------------------------------------------------------------------
+
+/**
+ * Class that can be used to register waitable objects and then wait
+ * for them. The objects are registered when they created and a Waiter
+ * instance is passed to them.
+ */
+class Waiter
+{
+public:
+    /**
+     * Wait for any if the waitables to become ready or until a
+     * timeout expires.
+     *
+     * If any of the waitables are ready, the function returns immediately.
+     *
+     * @return true if any of the waitables has become ready, false if
+     * the timeout occurs.
+     */
+    bool wait(int timeout = -1);
+};
+
+//------------------------------------------------------------------------------
+
+} /* namespace xplcommon */
+
+//------------------------------------------------------------------------------
+
+#endif // 0, The public interface of the Waiter class common to all platforms
+
 //------------------------------------------------------------------------------