diff options
author | megamage <none@none> | 2009-02-12 17:09:15 -0600 |
---|---|---|
committer | megamage <none@none> | 2009-02-12 17:09:15 -0600 |
commit | 6aee5fcbe7473a3cbac12b7e8482a7b98bef8be3 (patch) | |
tree | 91ec91d5c19eba9c2fe0e84b1c9dc7047a3de80e /dep/include/zthread/ThreadedExecutor.h | |
parent | 2d2f433b4de1c35b22aaf07854fc0ee11fcb350d (diff) | |
parent | f385747164c3fb278c92ef46fbd6c3da6590bbf0 (diff) |
*Merge.
--HG--
branch : trunk
Diffstat (limited to 'dep/include/zthread/ThreadedExecutor.h')
-rw-r--r-- | dep/include/zthread/ThreadedExecutor.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/dep/include/zthread/ThreadedExecutor.h b/dep/include/zthread/ThreadedExecutor.h index 9bc29b3c497..469a112f6bc 100644 --- a/dep/include/zthread/ThreadedExecutor.h +++ b/dep/include/zthread/ThreadedExecutor.h @@ -40,21 +40,21 @@ namespace ZThread { * A ThreadedExecutor spawns a new thread to execute each task submitted. * A ThreadedExecutor supports the following optional operations, * - * - <em>cancel</em>()ing a ThreadedExecutor will cause it to stop accepting - * new tasks. + * - <em>cancel</em>()ing a ThreadedExecutor will cause it to stop accepting + * new tasks. * - * - <em>interrupt</em>()ing a ThreadedExecutor will cause the any thread running - * a task which was submitted prior to the invocation of this function to + * - <em>interrupt</em>()ing a ThreadedExecutor will cause the any thread running + * a task which was submitted prior to the invocation of this function to * be interrupted during the execution of that task. * - * - <em>wait</em>()ing on a ThreadedExecutor will block the calling thread + * - <em>wait</em>()ing on a ThreadedExecutor will block the calling thread * until all tasks that were submitted prior to the invocation of this function * have completed. - * + * * @see Executor. */ class ThreadedExecutor : public Executor { - + CountedPtr< ExecutorImpl > _impl; public: @@ -68,16 +68,16 @@ namespace ZThread { /** * Interrupting a ThreadedExecutor will cause an interrupt() to be sent * to every Task that has been submitted at the time this function is - * called. Tasks that are submitted after this function is called will + * called. Tasks that are submitted after this function is called will * not be interrupt()ed; unless this function is invoked again(). */ virtual void interrupt(); - + /** - * Submit a task to this Executor. This will not block the current thread + * Submit a task to this Executor. This will not block the current thread * for very long. A new thread will be created and the task will be run() * within the context of that new thread. - * + * * @exception Cancellation_Exception thrown if this Executor has been canceled. * The Task being submitted will not be executed by this Executor. * @@ -89,12 +89,12 @@ namespace ZThread { * @see Cancelable::cancel() */ virtual void cancel(); - + /** * @see Cancelable::isCanceled() */ virtual bool isCanceled(); - + /** * Waiting on a ThreadedExecutor will block the current thread until all * tasks submitted to the Executor up until the time this function was called @@ -112,15 +112,15 @@ namespace ZThread { virtual void wait(); /** - * Operates the same as ThreadedExecutor::wait() but with a timeout. + * Operates the same as ThreadedExecutor::wait() but with a timeout. * - * @param timeout maximum amount of time, in milliseconds, to wait for the + * @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 interrupt()ed * while waiting for the current set of Tasks to complete. * - * @return + * @return * - <em>true</em> if the set of tasks running at the time this function is invoked complete * before <i>timeout</i> milliseconds elapse. * - <em>false</em> othewise. |