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
|
/*
* 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__
|
