Changeset 7:a3d84407fb9a in xplcommon for src/xplcommon

Timestamp:

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

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added the public interfaces

Location:

src/xplcommon

Files:

• Thread.h (modified) (1 diff)
• WaitableEvent.h (modified) (1 diff)
• Waiter.h (modified) (1 diff)

src/xplcommon/Thread.h

@@ -32 +32 @@
 //------------------------------------------------------------------------------
 
+// The public interface of the Thread class common to all platforms
+#if 0
+
+//------------------------------------------------------------------------------
+
+namespace xplcommon {
+
+//------------------------------------------------------------------------------
+
+/**
+ * A thread
+ */
+class Thread
+{
+public:
+    /**
+     * Virtual destructor.
+     */
+    virtual ~Thread();
+
+    /**
+     * Start the thread.
+     *
+     * @return if the thread could be started
+     */
+    bool start();
+
+    /**
+     * Perform the thread's real operation. To be implemented in children
+     */
+    virtual void run() = 0;
+
+    /**
+     * Wait for the thread to quit.
+     */
+    void join();
+};
+
+//------------------------------------------------------------------------------
+
+#endif // 0, The public interface of the Thread class common to all platforms
+
+//------------------------------------------------------------------------------
+
 #include "config.h"
 

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
+
 //------------------------------------------------------------------------------
 

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
+
 //------------------------------------------------------------------------------