/usr/include/zthread/ThreadedExecutor.h is in libzthread-dev 2.3.2-7ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | /*
* 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 __ZTTHREADEDEXECUTOR_H__
#define __ZTTHREADEDEXECUTOR_H__
#include "zthread/Executor.h"
#include "zthread/CountedPtr.h"
namespace ZThread {
namespace { class ExecutorImpl; }
/**
* @class ThreadedExecutor
*
* @author Eric Crahen <http://www.code-foo.com>
* @date <2003-07-16T22:39:13-0400>
* @version 2.3.0
*
* 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>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
* 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:
//! Create a new ThreadedExecutor
ThreadedExecutor();
//! Destroy a ThreadedExecutor
virtual ~ThreadedExecutor();
/**
* 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
* 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
* 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.
*
* @see Executor::execute(const Task&)
*/
virtual void execute(const Task&);
/**
* @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
* have completed.
*
* Tasks submitted after this function is called will not delay a thread that
* was already waiting on the Executor any longer. In order to wait for
* those tasks to complete as well, another wait() would be needed.
*
* @exception Interrupted_Exception thrown if the calling thread is interrupted
* before the set of tasks for which it was waiting complete.
*
* @see Waitable::wait()
*/
virtual void wait();
/**
* Operates the same as ThreadedExecutor::wait() but with a timeout.
*
* @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
* - <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.
*
* @see Waitable::wait(unsigned long timeout)
*/
virtual bool wait(unsigned long timeout);
}; /* ThreadedExecutor */
} // namespace ZThread
#endif // __ZTTHREADEDEXECUTOR_H__
|