Imported MaNGOS revision 6767 from http://mangos.svn.sourceforge.net/svnroot/mangos/trunk/

dep/include/zthread/SynchronousExecutor.h

@@ -0,0 +1,126 @@
+/*
+ * Copyright (c) 2005, Eric Crahen
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+#ifndef __ZTSYNCHRONOUSEXECUTOR_H__
+#define __ZTSYNCHRONOUSEXECUTOR_H__
+
+#include "zthread/Executor.h"
+#include "zthread/Guard.h"
+#include "zthread/Mutex.h"
+#include "zthread/Thread.h"
+
+namespace ZThread {
+
+  /**
+   * @class SynchronousExecutor
+   *
+   * @author Eric Crahen <http://www.code-foo.com>
+   * @date <2003-07-16T22:33:51-0400>
+   * @version 2.3.0
+   *
+   * A SynchronousExecutor is an Executor which runs tasks using the thread that 
+   * submits the task. It runs tasks serially, one at a time, in the order they
+   * were submitted to the executor.
+   *
+   * @see Executor.
+   */
+  class SynchronousExecutor : public Executor {
+    
+    //! Serialize access
+    Mutex _lock;
+
+    //! Cancellation flag
+    bool _canceled;
+
+    public:
+
+    //! Create a new SynchronousExecutor
+    SynchronousExecutor();
+
+    //! Destroy a SynchronousExecutor
+    virtual ~SynchronousExecutor();
+
+    /**
+     * This operation is not supported by this executor.
+     */
+    virtual void interrupt();
+
+    /**
+     * Submit a task to this Executor, blocking the calling thread until the 
+     * task is executed. 
+     *
+     * @param task Task to be run by a thread managed by this executor 
+     *
+     * @pre  The Executor should have been canceled prior to this invocation.
+     * @post The submitted task will be run at some point in the future by this Executor.
+     *
+     * @exception Cancellation_Exception thrown if the Executor was canceled prior to
+     *            the invocation of this function.
+     *
+     * @see Executor::execute(const Task& task)
+     */
+    virtual void execute(const Task& task);
+
+    /**
+     * @see Cancelable::cancel()
+     */
+    virtual void cancel();
+  
+    /**
+     * @see Cancelable::cancel()
+     */
+    virtual bool isCanceled();
+ 
+    /**
+     * Block the calling thread until all tasks submitted prior to this invocation
+     * complete.
+     *
+     * @exception Interrupted_Exception thrown if the calling thread is interrupted
+     *            before the set of tasks being wait for can complete.
+     *
+     * @see Executor::wait()
+     */
+    virtual void wait();
+
+    /**
+     * Block the calling thread until all tasks submitted prior to this invocation
+     * complete or until the calling thread is interrupted.
+     *
+     * @param timeout - maximum amount of time, in milliseconds, to wait for the 
+     * currently submitted set of Tasks to complete.
+     *
+     * @exception Interrupted_Exception thrown if the calling thread is interrupted
+     *            before the set of tasks being wait for can complete.
+     *
+     * @return 
+     *   - <em>true</em> if the set of tasks being wait for complete before 
+     *                   <i>timeout</i> milliseconds elapse.
+     *   - <em>false</em> othewise.
+     */
+    virtual bool wait(unsigned long timeout);
+
+
+  }; /* SynchronousExecutor */
+
+} // namespace ZThread
+
+#endif // __ZTSYNCHRONOUSEXECUTOR_H__