aboutsummaryrefslogtreecommitdiff
path: root/dep/include/zthread/ConcurrentExecutor.h
diff options
context:
space:
mode:
authormegamage <none@none>2009-02-12 17:09:15 -0600
committermegamage <none@none>2009-02-12 17:09:15 -0600
commit6aee5fcbe7473a3cbac12b7e8482a7b98bef8be3 (patch)
tree91ec91d5c19eba9c2fe0e84b1c9dc7047a3de80e /dep/include/zthread/ConcurrentExecutor.h
parent2d2f433b4de1c35b22aaf07854fc0ee11fcb350d (diff)
parentf385747164c3fb278c92ef46fbd6c3da6590bbf0 (diff)
*Merge.
--HG-- branch : trunk
Diffstat (limited to 'dep/include/zthread/ConcurrentExecutor.h')
-rw-r--r--dep/include/zthread/ConcurrentExecutor.h46
1 files changed, 23 insertions, 23 deletions
diff --git a/dep/include/zthread/ConcurrentExecutor.h b/dep/include/zthread/ConcurrentExecutor.h
index 199fe306e08..ccfd4a7ab67 100644
--- a/dep/include/zthread/ConcurrentExecutor.h
+++ b/dep/include/zthread/ConcurrentExecutor.h
@@ -35,7 +35,7 @@ namespace ZThread {
* @version 2.3.0
*
* A ConcurrentExecutor spawns a single thread to service a series of Tasks.
- *
+ *
* @see PoolExecutor.
*/
class ConcurrentExecutor : public Executor {
@@ -43,20 +43,20 @@ namespace ZThread {
PoolExecutor _executor;
public:
-
+
//! Create a ConcurrentExecutor
- ConcurrentExecutor();
+ ConcurrentExecutor();
/**
* Interrupting a ConcurrentExecutor will cause the thread running the tasks to be
- * be interrupted once during the execution of each task that has been submitted
+ * be interrupted once during the execution of each task that has been submitted
* at the time this function is called.
- *
- * Tasks that are submitted after this function is called will
+ *
+ * Tasks that are submitted after this function is called will
* not be interrupt()ed; unless this function is invoked again().
*
* @code
- *
+ *
* void aFunction() {
*
* ConcurrentExecutor executor;
@@ -65,60 +65,60 @@ namespace ZThread {
* for(size_t n = 0; n < p; n++)
* executor.execute(new aRunnable);
*
- * // Tasks [m, p) may be interrupted, where m is the first task that has
- * // not completed at the time the interrupt() is invoked.
+ * // Tasks [m, p) may be interrupted, where m is the first task that has
+ * // not completed at the time the interrupt() is invoked.
* executor.interrupt();
*
* // Submit (q - p) Tasks
* for(size_t n = p; n < q; n++)
* executor.execute(new Chore);
- *
- * // Tasks [p, q) are not interrupted
+ *
+ * // Tasks [p, q) are not interrupted
*
* }
*
* @endcode
*/
virtual void interrupt();
-
+
/**
- * Submit a Task to this Executor. This will not block the current thread
- * for very long. The task will be enqueued internally and eventually run
- * in the context of the single thread driving all the Tasks submitted to this
+ * Submit a Task to this Executor. This will not block the current thread
+ * for very long. The task will be enqueued internally and eventually run
+ * in the context of the single thread driving all the Tasks submitted to this
* Executor.
- *
+ *
* @exception Cancellation_Exception thrown if this Executor has been canceled.
* The Task being submitted will not be executed by this Executor.
*
- * @exception Synchronization_Exception thrown only in the event of an error
+ * @exception Synchronization_Exception thrown only in the event of an error
* in the implementation of the library.
*
* @see Executor::execute(const Task&)
*/
virtual void execute(const Task&);
-
+
/**
* @see Cancelable::cancel()
*/
virtual void cancel();
-
+
/**
* @see Cancelable::isCanceled()
*/
virtual bool isCanceled();
-
+
/**
* @see PoolExecutor::wait()
*/
virtual void wait();
-
+
/**
* @see PoolExecutor::wait(unsigned long timeout)
*/
virtual bool wait(unsigned long timeout);
-
+
}; /* ConcurrentExecutor */
-
+
} // namespace ZThread
#endif // __ZTCONCURRENTEXECUTOR_H__