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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _VOS_THREAD_HXX_
#define _VOS_THREAD_HXX_
# include <vos/types.hxx>
# include <vos/object.hxx>
# include <osl/thread.h>
# include <osl/conditn.h>
# include <vos/runnable.hxx>
#include <osl/time.h>
namespace vos
{
extern "C" typedef void ThreadWorkerFunction_impl(void *);
ThreadWorkerFunction_impl threadWorkerFunction_impl;
/** OThread is an objectoriented interface for threads.
This class should be the base class for all objects using threads. The
main working function is the run() method and should be overriden in the
derived class. To support soft termination of a thread, yield() should
be called in regular intervalls and the return value should be checked.
If yield returned False the run method should return.
@author Bernd Hofner
@version 1.0
*/
class OThread : public vos::IRunnable,
public vos::OObject
{
VOS_DECLARE_CLASSINFO(VOS_NAMESPACE(OThread, vos));
oslCondition m_aCondition;
public:
/** priority of thread.
*/
enum TThreadPriority
{
TPriority_Highest = osl_Thread_PriorityHighest,
TPriority_AboveNormal = osl_Thread_PriorityAboveNormal,
TPriority_Normal = osl_Thread_PriorityNormal,
TPriority_BelowNormal = osl_Thread_PriorityBelowNormal,
TPriority_Lowest = osl_Thread_PriorityLowest,
TPriority_Unknown = osl_Thread_PriorityUnknown
};
/**
*/
enum TThreadSleep
{
TSleep_Normal,
TSleep_Cancel,
TSleep_Pending,
TSleep_Active,
TSleep_Error,
TSleep_Unknown
};
typedef oslThreadIdentifier TThreadIdentifier;
/// Constructor
OThread();
/// Destructor kills thread if neccessary
virtual ~OThread();
/** Create running instance of a thread.
@returns True if thread could be created.
*/
sal_Bool SAL_CALL create();
/** Create suspended instance of a thread.
@returns True if thread could be created.
*/
sal_Bool SAL_CALL createSuspended();
/// Suspend a runnng thread
void SAL_CALL suspend();
/// Resume a suspended thread
void SAL_CALL resume();
/** Tries to kill the thread.
will not block and might not succeed when run() won't heed isTerminationRequested().
*/
virtual void SAL_CALL terminate();
/// Kill thread hard and block until it is actually gone
virtual void SAL_CALL kill();
/// Block till thread is terminated
void SAL_CALL join();
/// Check if thread is running.
sal_Bool SAL_CALL isRunning();
/** Change thread priority.
The valid priority levels are:
<ul>
<li>ThreadPriorityHighest,
<li>ThreadPriorityAboveNormal,
<li>ThreadPriorityNormal,
<li>ThreadPriorityBelowNormal,
<li>ThreadPriorityLowest,
</ul>
*/
void SAL_CALL setPriority(TThreadPriority Priority);
/** Query thread priority.
Valid return values are:
<ul>
<li>ThreadPriorityHighest,
<li>ThreadPriorityAboveNormal,
<li>ThreadPriorityNormal,
<li>ThreadPriorityBelowNormal,
<li>ThreadPriorityLowest,
<li>ThreadPriorityUnknown (returned if thread is killed)
</ul>
*/
TThreadPriority SAL_CALL getPriority();
TThreadIdentifier SAL_CALL getIdentifier() const;
static TThreadIdentifier SAL_CALL getCurrentIdentifier();
/** Let thread sleep a specified amout of time.
@param Delay specifies the number of time to sleep.
*/
TThreadSleep SAL_CALL sleep(const TimeValue& Delay);
/** Awake the sleeping thread.
@returns False if at least one of the handles is invalid
or the thread is not sleeping.
*/
sal_Bool SAL_CALL awake();
/** Let current thread wait a specified amout of time.
@param Delay specifies the number of time
to wait. Note, if you need to interrupt the waiting operation
use sleep instead.
*/
static void SAL_CALL wait(const TimeValue& Delay);
/** Reschedules threads.
Call within your loop if you
want other threads offer some processing time.
This method is static, so it might be used by the
main-thread.
*/
static void SAL_CALL yield();
protected:
/// Working method which should be overridden.
virtual void SAL_CALL run() = 0;
/** Checks if thread should terminate.
isTerminationRequested() will return True if someone called
terminate().
@return True if thread should terminate, False if he can continue.
*/
virtual sal_Bool SAL_CALL schedule();
/** Called when run() is done.
You might want to override it to do some cleanup.
*/
virtual void SAL_CALL onTerminated();
protected:
oslThread m_hThread;
sal_Bool m_bTerminating;
friend void threadWorkerFunction_impl(void *);
};
class OThreadData : public vos::OObject
{
VOS_DECLARE_CLASSINFO(VOS_NAMESPACE(OThreadData, vos));
public:
/// Create a thread specific local data key
OThreadData( oslThreadKeyCallbackFunction = 0 );
/// Destroy a thread specific local data key
virtual ~OThreadData();
/** Set the data associated with the data key.
@returns True if operation was successfull
*/
sal_Bool SAL_CALL setData(void *pData);
/** Get the data associated with the data key.
@returns The data asscoitaed with the data key or
NULL if no data was set
*/
void* SAL_CALL getData();
protected:
oslThreadKey m_hKey;
};
}
#endif // _VOS_THREAD_HXX_
|
