]>
Commit | Line | Data |
---|---|---|
10b959e3 | 1 | ///////////////////////////////////////////////////////////////////////////// |
9e84b847 | 2 | // Name: wx/thread.h |
10b959e3 JS |
3 | // Purpose: Thread API |
4 | // Author: Guilhem Lavaux | |
bf1852e1 VZ |
5 | // Modified by: Vadim Zeitlin (modifications partly inspired by omnithreads |
6 | // package from Olivetti & Oracle Research Laboratory) | |
10b959e3 JS |
7 | // Created: 04/13/98 |
8 | // RCS-ID: $Id$ | |
9 | // Copyright: (c) Guilhem Lavaux | |
65571936 | 10 | // Licence: wxWindows licence |
10b959e3 JS |
11 | ///////////////////////////////////////////////////////////////////////////// |
12 | ||
9e84b847 VZ |
13 | #ifndef _WX_THREAD_H_ |
14 | #define _WX_THREAD_H_ | |
10b959e3 | 15 | |
9d133d87 VZ |
16 | // ---------------------------------------------------------------------------- |
17 | // headers | |
18 | // ---------------------------------------------------------------------------- | |
bf1852e1 VZ |
19 | |
20 | // get the value of wxUSE_THREADS configuration flag | |
9e84b847 | 21 | #include "wx/defs.h" |
9d133d87 VZ |
22 | |
23 | #if wxUSE_THREADS | |
6d167489 | 24 | |
bf1852e1 VZ |
25 | // Windows headers define it |
26 | #ifdef Yield | |
27 | #undef Yield | |
28 | #endif | |
29 | ||
a6b0bd49 VZ |
30 | // ---------------------------------------------------------------------------- |
31 | // constants | |
32 | // ---------------------------------------------------------------------------- | |
33 | ||
6d167489 | 34 | enum wxMutexError |
d524867f | 35 | { |
9e84b847 VZ |
36 | wxMUTEX_NO_ERROR = 0, // operation completed successfully |
37 | wxMUTEX_INVALID, // mutex hasn't been initialized | |
38 | wxMUTEX_DEAD_LOCK, // mutex is already locked by the calling thread | |
39 | wxMUTEX_BUSY, // mutex is already locked by another thread | |
40 | wxMUTEX_UNLOCKED, // attempt to unlock a mutex which is not locked | |
41 | wxMUTEX_MISC_ERROR // any other error | |
42 | }; | |
43 | ||
44 | enum wxCondError | |
45 | { | |
46 | wxCOND_NO_ERROR = 0, | |
47 | wxCOND_INVALID, | |
48 | wxCOND_TIMEOUT, // WaitTimeout() has timed out | |
49 | wxCOND_MISC_ERROR | |
50 | }; | |
51 | ||
52 | enum wxSemaError | |
53 | { | |
54 | wxSEMA_NO_ERROR = 0, | |
55 | wxSEMA_INVALID, // semaphore hasn't been initialized successfully | |
56 | wxSEMA_BUSY, // returned by TryWait() if Wait() would block | |
57 | wxSEMA_TIMEOUT, // returned by WaitTimeout() | |
58 | wxSEMA_OVERFLOW, // Post() would increase counter past the max | |
59 | wxSEMA_MISC_ERROR | |
6d167489 | 60 | }; |
10b959e3 | 61 | |
6d167489 | 62 | enum wxThreadError |
d524867f | 63 | { |
9fc3ad34 VZ |
64 | wxTHREAD_NO_ERROR = 0, // No error |
65 | wxTHREAD_NO_RESOURCE, // No resource left to create a new thread | |
66 | wxTHREAD_RUNNING, // The thread is already running | |
67 | wxTHREAD_NOT_RUNNING, // The thread isn't running | |
68 | wxTHREAD_KILLED, // Thread we waited for had to be killed | |
69 | wxTHREAD_MISC_ERROR // Some other error | |
6d167489 | 70 | }; |
10b959e3 | 71 | |
b568d04f VZ |
72 | enum wxThreadKind |
73 | { | |
74 | wxTHREAD_DETACHED, | |
75 | wxTHREAD_JOINABLE | |
76 | }; | |
77 | ||
bf1852e1 | 78 | // defines the interval of priority |
6d167489 VZ |
79 | enum |
80 | { | |
81 | WXTHREAD_MIN_PRIORITY = 0u, | |
82 | WXTHREAD_DEFAULT_PRIORITY = 50u, | |
83 | WXTHREAD_MAX_PRIORITY = 100u | |
84 | }; | |
10b959e3 | 85 | |
9e84b847 VZ |
86 | // There are 2 types of mutexes: normal mutexes and recursive ones. The attempt |
87 | // to lock a normal mutex by a thread which already owns it results in | |
88 | // undefined behaviour (it always works under Windows, it will almost always | |
89 | // result in a deadlock under Unix). Locking a recursive mutex in such | |
90 | // situation always succeeds and it must be unlocked as many times as it has | |
91 | // been locked. | |
92 | // | |
93 | // However recursive mutexes have several important drawbacks: first, in the | |
94 | // POSIX implementation, they're less efficient. Second, and more importantly, | |
95 | // they CAN NOT BE USED WITH CONDITION VARIABLES under Unix! Using them with | |
96 | // wxCondition will work under Windows and some Unices (notably Linux) but will | |
97 | // deadlock under other Unix versions (e.g. Solaris). As it might be difficult | |
98 | // to ensure that a recursive mutex is not used with wxCondition, it is a good | |
99 | // idea to avoid using recursive mutexes at all. Also, the last problem with | |
100 | // them is that some (older) Unix versions don't support this at all -- which | |
101 | // results in a configure warning when building and a deadlock when using them. | |
102 | enum wxMutexType | |
103 | { | |
104 | // normal mutex: try to always use this one | |
105 | wxMUTEX_DEFAULT, | |
106 | ||
107 | // recursive mutex: don't use these ones with wxCondition | |
108 | wxMUTEX_RECURSIVE | |
109 | }; | |
110 | ||
111 | // forward declarations | |
78ee6a47 | 112 | class WXDLLIMPEXP_BASE wxThreadHelper; |
bb24c68f VS |
113 | class WXDLLIMPEXP_BASE wxConditionInternal; |
114 | class WXDLLIMPEXP_BASE wxMutexInternal; | |
115 | class WXDLLIMPEXP_BASE wxSemaphoreInternal; | |
116 | class WXDLLIMPEXP_BASE wxThreadInternal; | |
9e84b847 | 117 | |
d524867f | 118 | // ---------------------------------------------------------------------------- |
9d133d87 VZ |
119 | // A mutex object is a synchronization object whose state is set to signaled |
120 | // when it is not owned by any thread, and nonsignaled when it is owned. Its | |
121 | // name comes from its usefulness in coordinating mutually-exclusive access to | |
122 | // a shared resource. Only one thread at a time can own a mutex object. | |
a6b0bd49 | 123 | // ---------------------------------------------------------------------------- |
d524867f | 124 | |
9d133d87 VZ |
125 | // you should consider wxMutexLocker whenever possible instead of directly |
126 | // working with wxMutex class - it is safer | |
bb24c68f | 127 | class WXDLLIMPEXP_BASE wxMutex |
d524867f | 128 | { |
10b959e3 | 129 | public: |
bf1852e1 | 130 | // constructor & destructor |
9e84b847 VZ |
131 | // ------------------------ |
132 | ||
133 | // create either default (always safe) or recursive mutex | |
134 | wxMutex(wxMutexType mutexType = wxMUTEX_DEFAULT); | |
135 | ||
136 | // destroys the mutex kernel object | |
cb4f1ca4 | 137 | ~wxMutex(); |
10b959e3 | 138 | |
9e84b847 VZ |
139 | // test if the mutex has been created successfully |
140 | bool IsOk() const; | |
141 | ||
142 | // mutex operations | |
143 | // ---------------- | |
144 | ||
145 | // Lock the mutex, blocking on it until it is unlocked by the other thread. | |
146 | // The result of locking a mutex already locked by the current thread | |
147 | // depend on the mutex type. | |
148 | // | |
149 | // The caller must call Unlock() later if Lock() returned wxMUTEX_NO_ERROR. | |
cb4f1ca4 | 150 | wxMutexError Lock(); |
9e84b847 VZ |
151 | |
152 | // Try to lock the mutex: if it is currently locked, return immediately | |
153 | // with an error. Otherwise the caller must call Unlock(). | |
cb4f1ca4 | 154 | wxMutexError TryLock(); |
10b959e3 | 155 | |
9e84b847 VZ |
156 | // Unlock the mutex. It is an error to unlock an already unlocked mutex |
157 | wxMutexError Unlock(); | |
a6b0bd49 | 158 | |
10b959e3 | 159 | protected: |
9fc3ad34 | 160 | wxMutexInternal *m_internal; |
be809868 VZ |
161 | |
162 | friend class wxConditionInternal; | |
9e84b847 VZ |
163 | |
164 | DECLARE_NO_COPY_CLASS(wxMutex) | |
10b959e3 JS |
165 | }; |
166 | ||
9d133d87 VZ |
167 | // a helper class which locks the mutex in the ctor and unlocks it in the dtor: |
168 | // this ensures that mutex is always unlocked, even if the function returns or | |
169 | // throws an exception before it reaches the end | |
bb24c68f | 170 | class WXDLLIMPEXP_BASE wxMutexLocker |
9d133d87 VZ |
171 | { |
172 | public: | |
173 | // lock the mutex in the ctor | |
be52b341 | 174 | wxMutexLocker(wxMutex& mutex) |
c096f614 | 175 | : m_isOk(false), m_mutex(mutex) |
be52b341 | 176 | { m_isOk = ( m_mutex.Lock() == wxMUTEX_NO_ERROR ); } |
9d133d87 | 177 | |
c096f614 | 178 | // returns true if mutex was successfully locked in ctor |
7c3d7e2d VZ |
179 | bool IsOk() const |
180 | { return m_isOk; } | |
9d133d87 VZ |
181 | |
182 | // unlock the mutex in dtor | |
7c3d7e2d VZ |
183 | ~wxMutexLocker() |
184 | { if ( IsOk() ) m_mutex.Unlock(); } | |
9d133d87 VZ |
185 | |
186 | private: | |
cb4f1ca4 VZ |
187 | // no assignment operator nor copy ctor |
188 | wxMutexLocker(const wxMutexLocker&); | |
189 | wxMutexLocker& operator=(const wxMutexLocker&); | |
190 | ||
9d133d87 | 191 | bool m_isOk; |
7c3d7e2d | 192 | wxMutex& m_mutex; |
9d133d87 VZ |
193 | }; |
194 | ||
195 | // ---------------------------------------------------------------------------- | |
196 | // Critical section: this is the same as mutex but is only visible to the | |
197 | // threads of the same process. For the platforms which don't have native | |
198 | // support for critical sections, they're implemented entirely in terms of | |
6d167489 VZ |
199 | // mutexes. |
200 | // | |
201 | // NB: wxCriticalSection object does not allocate any memory in its ctor | |
202 | // which makes it possible to have static globals of this class | |
9d133d87 VZ |
203 | // ---------------------------------------------------------------------------- |
204 | ||
6d167489 VZ |
205 | // in order to avoid any overhead under platforms where critical sections are |
206 | // just mutexes make all wxCriticalSection class functions inline | |
02f463e9 | 207 | #if !defined(__WXMSW__) && !defined(__WXMAC__) |
6d167489 | 208 | #define wxCRITSECT_IS_MUTEX 1 |
d42e3d59 VZ |
209 | |
210 | #define wxCRITSECT_INLINE inline | |
d1bab566 | 211 | #else // MSW |
6d167489 | 212 | #define wxCRITSECT_IS_MUTEX 0 |
d42e3d59 VZ |
213 | |
214 | #define wxCRITSECT_INLINE | |
f6ddc54a | 215 | #endif // MSW/!MSW |
bf1852e1 VZ |
216 | |
217 | // you should consider wxCriticalSectionLocker whenever possible instead of | |
218 | // directly working with wxCriticalSection class - it is safer | |
bb24c68f | 219 | class WXDLLIMPEXP_BASE wxCriticalSection |
9d133d87 VZ |
220 | { |
221 | public: | |
222 | // ctor & dtor | |
d42e3d59 VZ |
223 | wxCRITSECT_INLINE wxCriticalSection(); |
224 | wxCRITSECT_INLINE ~wxCriticalSection(); | |
9d133d87 VZ |
225 | |
226 | // enter the section (the same as locking a mutex) | |
d42e3d59 | 227 | wxCRITSECT_INLINE void Enter(); |
9e84b847 | 228 | |
9d133d87 | 229 | // leave the critical section (same as unlocking a mutex) |
d42e3d59 | 230 | wxCRITSECT_INLINE void Leave(); |
9d133d87 VZ |
231 | |
232 | private: | |
6d167489 | 233 | #if wxCRITSECT_IS_MUTEX |
f6ddc54a | 234 | wxMutex m_mutex; |
6d167489 VZ |
235 | #elif defined(__WXMSW__) |
236 | // we can't allocate any memory in the ctor, so use placement new - | |
237 | // unfortunately, we have to hardcode the sizeof() here because we can't | |
dac348b9 VZ |
238 | // include windows.h from this public header and we also have to use the |
239 | // union to force the correct (i.e. maximal) alignment | |
9e84b847 | 240 | // |
1c6f2414 WS |
241 | // if CRITICAL_SECTION size changes in Windows, you'll get an assert from |
242 | // thread.cpp and will need to increase the buffer size | |
dac348b9 VZ |
243 | // |
244 | // finally, we need this typedef instead of declaring m_buffer directly | |
245 | // because otherwise the assert mentioned above wouldn't compile with some | |
246 | // compilers (notably CodeWarrior 8) | |
975b6bcf VZ |
247 | #ifdef __WIN64__ |
248 | typedef char wxCritSectBuffer[40]; | |
249 | #else // __WIN32__ | |
dac348b9 | 250 | typedef char wxCritSectBuffer[24]; |
975b6bcf | 251 | #endif |
dac348b9 VZ |
252 | union |
253 | { | |
254 | unsigned long m_dummy1; | |
255 | void *m_dummy2; | |
256 | ||
257 | wxCritSectBuffer m_buffer; | |
258 | }; | |
02f463e9 SC |
259 | #elif defined(__WXMAC__) |
260 | void *m_critRegion ; | |
d1bab566 | 261 | #endif // Unix&OS2/Win32 |
9e84b847 VZ |
262 | |
263 | DECLARE_NO_COPY_CLASS(wxCriticalSection) | |
9d133d87 VZ |
264 | }; |
265 | ||
9e84b847 VZ |
266 | #if wxCRITSECT_IS_MUTEX |
267 | // implement wxCriticalSection using mutexes | |
d42e3d59 VZ |
268 | inline wxCriticalSection::wxCriticalSection() { } |
269 | inline wxCriticalSection::~wxCriticalSection() { } | |
9e84b847 | 270 | |
d42e3d59 VZ |
271 | inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); } |
272 | inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); } | |
9e84b847 | 273 | #endif // wxCRITSECT_IS_MUTEX |
bf1852e1 | 274 | |
d42e3d59 VZ |
275 | #undef wxCRITSECT_INLINE |
276 | #undef wxCRITSECT_IS_MUTEX | |
277 | ||
9d133d87 | 278 | // wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is |
87b6002d | 279 | // to mutexes |
bb24c68f | 280 | class WXDLLIMPEXP_BASE wxCriticalSectionLocker |
9d133d87 VZ |
281 | { |
282 | public: | |
9e84b847 VZ |
283 | wxCriticalSectionLocker(wxCriticalSection& cs) |
284 | : m_critsect(cs) | |
285 | { | |
286 | m_critsect.Enter(); | |
287 | } | |
9d133d87 | 288 | |
9e84b847 VZ |
289 | ~wxCriticalSectionLocker() |
290 | { | |
291 | m_critsect.Leave(); | |
292 | } | |
cb4f1ca4 | 293 | |
9e84b847 | 294 | private: |
bee503b0 | 295 | wxCriticalSection& m_critsect; |
9e84b847 VZ |
296 | |
297 | DECLARE_NO_COPY_CLASS(wxCriticalSectionLocker) | |
9d133d87 VZ |
298 | }; |
299 | ||
a6b0bd49 | 300 | // ---------------------------------------------------------------------------- |
be809868 VZ |
301 | // wxCondition models a POSIX condition variable which allows one (or more) |
302 | // thread(s) to wait until some condition is fulfilled | |
a6b0bd49 | 303 | // ---------------------------------------------------------------------------- |
d524867f | 304 | |
bb24c68f | 305 | class WXDLLIMPEXP_BASE wxCondition |
d524867f | 306 | { |
10b959e3 | 307 | public: |
9e84b847 VZ |
308 | // Each wxCondition object is associated with a (single) wxMutex object. |
309 | // The mutex object MUST be locked before calling Wait() | |
c112e100 | 310 | wxCondition(wxMutex& mutex); |
be809868 VZ |
311 | |
312 | // dtor is not virtual, don't use this class polymorphically | |
9fc3ad34 VZ |
313 | ~wxCondition(); |
314 | ||
c096f614 | 315 | // return true if the condition has been created successfully |
9e84b847 VZ |
316 | bool IsOk() const; |
317 | ||
be809868 | 318 | // NB: the associated mutex MUST be locked beforehand by the calling thread |
cb719f2e | 319 | // |
be809868 VZ |
320 | // it atomically releases the lock on the associated mutex |
321 | // and starts waiting to be woken up by a Signal()/Broadcast() | |
322 | // once its signaled, then it will wait until it can reacquire | |
323 | // the lock on the associated mutex object, before returning. | |
9e84b847 | 324 | wxCondError Wait(); |
9fc3ad34 | 325 | |
be809868 VZ |
326 | // exactly as Wait() except that it may also return if the specified |
327 | // timeout ellapses even if the condition hasn't been signalled: in this | |
c096f614 VZ |
328 | // case, the return value is false, otherwise (i.e. in case of a normal |
329 | // return) it is true | |
cb719f2e | 330 | // |
be809868 VZ |
331 | // the timeeout parameter specifies a interval that needs to be waited in |
332 | // milliseconds | |
9e84b847 | 333 | wxCondError WaitTimeout(unsigned long milliseconds); |
be809868 VZ |
334 | |
335 | // NB: the associated mutex may or may not be locked by the calling thread | |
336 | // | |
337 | // this method unblocks one thread if any are blocking on the condition. | |
338 | // if no thread is blocking in Wait(), then the signal is NOT remembered | |
339 | // The thread which was blocking on Wait(), will then reacquire the lock | |
340 | // on the associated mutex object before returning | |
9e84b847 | 341 | wxCondError Signal(); |
a6b0bd49 | 342 | |
be809868 VZ |
343 | // NB: the associated mutex may or may not be locked by the calling thread |
344 | // | |
345 | // this method unblocks all threads if any are blocking on the condition. | |
346 | // if no thread is blocking in Wait(), then the signal is NOT remembered | |
347 | // The threads which were blocking on Wait(), will then reacquire the lock | |
348 | // on the associated mutex object before returning. | |
9e84b847 VZ |
349 | wxCondError Broadcast(); |
350 | ||
351 | ||
352 | // deprecated version, don't use | |
353 | bool Wait(unsigned long milliseconds) | |
354 | { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; } | |
8d5eff60 | 355 | |
10b959e3 | 356 | private: |
9fc3ad34 | 357 | wxConditionInternal *m_internal; |
9e84b847 VZ |
358 | |
359 | DECLARE_NO_COPY_CLASS(wxCondition) | |
10b959e3 JS |
360 | }; |
361 | ||
a6b0bd49 | 362 | // ---------------------------------------------------------------------------- |
be809868 VZ |
363 | // wxSemaphore: a counter limiting the number of threads concurrently accessing |
364 | // a shared resource | |
365 | // ---------------------------------------------------------------------------- | |
366 | ||
bb24c68f | 367 | class WXDLLIMPEXP_BASE wxSemaphore |
be809868 VZ |
368 | { |
369 | public: | |
370 | // specifying a maxcount of 0 actually makes wxSemaphore behave as if there | |
371 | // is no upper limit, if maxcount is 1 the semaphore behaves as a mutex | |
372 | wxSemaphore( int initialcount = 0, int maxcount = 0 ); | |
373 | ||
374 | // dtor is not virtual, don't use this class polymorphically | |
375 | ~wxSemaphore(); | |
376 | ||
c096f614 | 377 | // return true if the semaphore has been created successfully |
9e84b847 VZ |
378 | bool IsOk() const; |
379 | ||
be809868 VZ |
380 | // wait indefinitely, until the semaphore count goes beyond 0 |
381 | // and then decrement it and return (this method might have been called | |
382 | // Acquire()) | |
9e84b847 | 383 | wxSemaError Wait(); |
be809868 | 384 | |
9e84b847 VZ |
385 | // same as Wait(), but does not block, returns wxSEMA_NO_ERROR if |
386 | // successful and wxSEMA_BUSY if the count is currently zero | |
387 | wxSemaError TryWait(); | |
be809868 | 388 | |
9e84b847 VZ |
389 | // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the |
390 | // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has ellapsed | |
391 | wxSemaError WaitTimeout(unsigned long milliseconds); | |
be809868 VZ |
392 | |
393 | // increments the semaphore count and signals one of the waiting threads | |
9e84b847 | 394 | wxSemaError Post(); |
be809868 VZ |
395 | |
396 | private: | |
397 | wxSemaphoreInternal *m_internal; | |
9e84b847 VZ |
398 | |
399 | DECLARE_NO_COPY_CLASS(wxSemaphore) | |
be809868 VZ |
400 | }; |
401 | ||
402 | // ---------------------------------------------------------------------------- | |
87b6002d | 403 | // wxThread: class encapsulating a thread of execution |
a6b0bd49 | 404 | // ---------------------------------------------------------------------------- |
d524867f | 405 | |
b568d04f VZ |
406 | // there are two different kinds of threads: joinable and detached (default) |
407 | // ones. Only joinable threads can return a return code and only detached | |
408 | // threads auto-delete themselves - the user should delete the joinable | |
409 | // threads manually. | |
bf1852e1 VZ |
410 | |
411 | // NB: in the function descriptions the words "this thread" mean the thread | |
412 | // created by the wxThread object while "main thread" is the thread created | |
413 | // during the process initialization (a.k.a. the GUI thread) | |
b568d04f | 414 | |
547b93ab VZ |
415 | // On VMS thread pointers are 64 bits (also needed for other systems??? |
416 | #ifdef __VMS | |
417 | typedef unsigned long long wxThreadIdType; | |
418 | #else | |
419 | typedef unsigned long wxThreadIdType; | |
420 | #endif | |
421 | ||
bb24c68f | 422 | class WXDLLIMPEXP_BASE wxThread |
d524867f | 423 | { |
10b959e3 | 424 | public: |
bf1852e1 VZ |
425 | // the return type for the thread function |
426 | typedef void *ExitCode; | |
427 | ||
428 | // static functions | |
429 | // Returns the wxThread object for the calling thread. NULL is returned | |
430 | // if the caller is the main thread (but it's recommended to use | |
431 | // IsMain() and only call This() for threads other than the main one | |
432 | // because NULL is also returned on error). If the thread wasn't | |
433 | // created with wxThread class, the returned value is undefined. | |
434 | static wxThread *This(); | |
435 | ||
436 | // Returns true if current thread is the main thread. | |
437 | static bool IsMain(); | |
438 | ||
439 | // Release the rest of our time slice leting the other threads run | |
440 | static void Yield(); | |
441 | ||
442 | // Sleep during the specified period of time in milliseconds | |
443 | // | |
444 | // NB: at least under MSW worker threads can not call ::wxSleep()! | |
445 | static void Sleep(unsigned long milliseconds); | |
446 | ||
ef8d96c2 VZ |
447 | // get the number of system CPUs - useful with SetConcurrency() |
448 | // (the "best" value for it is usually number of CPUs + 1) | |
449 | // | |
450 | // Returns -1 if unknown, number of CPUs otherwise | |
451 | static int GetCPUCount(); | |
452 | ||
4958ea8f RD |
453 | // Get the platform specific thread ID and return as a long. This |
454 | // can be used to uniquely identify threads, even if they are not | |
455 | // wxThreads. This is used by wxPython. | |
547b93ab VZ |
456 | static wxThreadIdType GetCurrentId(); |
457 | ||
ef8d96c2 VZ |
458 | // sets the concurrency level: this is, roughly, the number of threads |
459 | // the system tries to schedule to run in parallel. 0 means the | |
460 | // default value (usually acceptable, but may not yield the best | |
461 | // performance for this process) | |
462 | // | |
c096f614 | 463 | // Returns true on success, false otherwise (if not implemented, for |
ef8d96c2 VZ |
464 | // example) |
465 | static bool SetConcurrency(size_t level); | |
466 | ||
b568d04f VZ |
467 | // constructor only creates the C++ thread object and doesn't create (or |
468 | // start) the real thread | |
469 | wxThread(wxThreadKind kind = wxTHREAD_DETACHED); | |
470 | ||
471 | // functions that change the thread state: all these can only be called | |
472 | // from _another_ thread (typically the thread that created this one, e.g. | |
473 | // the main thread), not from the thread itself | |
bf1852e1 | 474 | |
6fe73788 RL |
475 | // create a new thread and optionally set the stack size on |
476 | // platforms that support that - call Run() to start it | |
477 | // (special cased for watcom which won't accept 0 default) | |
478 | ||
6fe73788 | 479 | wxThreadError Create(unsigned int stackSize = 0); |
bf1852e1 | 480 | |
b568d04f VZ |
481 | // starts execution of the thread - from the moment Run() is called |
482 | // the execution of wxThread::Entry() may start at any moment, caller | |
bf1852e1 VZ |
483 | // shouldn't suppose that it starts after (or before) Run() returns. |
484 | wxThreadError Run(); | |
485 | ||
b568d04f VZ |
486 | // stops the thread if it's running and deletes the wxThread object if |
487 | // this is a detached thread freeing its memory - otherwise (for | |
488 | // joinable threads) you still need to delete wxThread object | |
489 | // yourself. | |
490 | // | |
491 | // this function only works if the thread calls TestDestroy() | |
492 | // periodically - the thread will only be deleted the next time it | |
493 | // does it! | |
494 | // | |
495 | // will fill the rc pointer with the thread exit code if it's !NULL | |
496 | wxThreadError Delete(ExitCode *rc = (ExitCode *)NULL); | |
497 | ||
498 | // waits for a joinable thread to finish and returns its exit code | |
499 | // | |
500 | // Returns (ExitCode)-1 on error (for example, if the thread is not | |
501 | // joinable) | |
502 | ExitCode Wait(); | |
bf1852e1 VZ |
503 | |
504 | // kills the thread without giving it any chance to clean up - should | |
505 | // not be used in normal circumstances, use Delete() instead. It is a | |
506 | // dangerous function that should only be used in the most extreme | |
b568d04f VZ |
507 | // cases! |
508 | // | |
509 | // The wxThread object is deleted by Kill() if the thread is | |
510 | // detachable, but you still have to delete it manually for joinable | |
511 | // threads. | |
bf1852e1 VZ |
512 | wxThreadError Kill(); |
513 | ||
b568d04f VZ |
514 | // pause a running thread: as Delete(), this only works if the thread |
515 | // calls TestDestroy() regularly | |
bf1852e1 VZ |
516 | wxThreadError Pause(); |
517 | ||
518 | // resume a paused thread | |
519 | wxThreadError Resume(); | |
520 | ||
521 | // priority | |
522 | // Sets the priority to "prio": see WXTHREAD_XXX_PRIORITY constants | |
523 | // | |
524 | // NB: the priority can only be set before the thread is created | |
525 | void SetPriority(unsigned int prio); | |
526 | ||
527 | // Get the current priority. | |
528 | unsigned int GetPriority() const; | |
529 | ||
bf1852e1 VZ |
530 | // thread status inquiries |
531 | // Returns true if the thread is alive: i.e. running or suspended | |
532 | bool IsAlive() const; | |
533 | // Returns true if the thread is running (not paused, not killed). | |
534 | bool IsRunning() const; | |
535 | // Returns true if the thread is suspended | |
a737331d | 536 | bool IsPaused() const; |
bf1852e1 | 537 | |
b568d04f VZ |
538 | // is the thread of detached kind? |
539 | bool IsDetached() const { return m_isDetached; } | |
540 | ||
541 | // Get the thread ID - a platform dependent number which uniquely | |
542 | // identifies a thread inside a process | |
547b93ab | 543 | wxThreadIdType GetId() const; |
4958ea8f | 544 | |
bf1852e1 VZ |
545 | // called when the thread exits - in the context of this thread |
546 | // | |
547 | // NB: this function will not be called if the thread is Kill()ed | |
548 | virtual void OnExit() { } | |
10b959e3 | 549 | |
c096f614 VZ |
550 | // Returns true if the thread was asked to terminate: this function should |
551 | // be called by the thread from time to time, otherwise the main thread | |
552 | // will be left forever in Delete()! | |
553 | virtual bool TestDestroy(); | |
554 | ||
b568d04f VZ |
555 | // dtor is public, but the detached threads should never be deleted - use |
556 | // Delete() instead (or leave the thread terminate by itself) | |
557 | virtual ~wxThread(); | |
558 | ||
bf1852e1 | 559 | protected: |
bf1852e1 | 560 | // exits from the current thread - can be called only from this thread |
b568d04f | 561 | void Exit(ExitCode exitcode = 0); |
9d133d87 | 562 | |
bf1852e1 VZ |
563 | // entry point for the thread - called by Run() and executes in the context |
564 | // of this thread. | |
565 | virtual void *Entry() = 0; | |
a6b0bd49 | 566 | |
10b959e3 | 567 | private: |
bf1852e1 VZ |
568 | // no copy ctor/assignment operator |
569 | wxThread(const wxThread&); | |
570 | wxThread& operator=(const wxThread&); | |
10b959e3 | 571 | |
bf1852e1 VZ |
572 | friend class wxThreadInternal; |
573 | ||
574 | // the (platform-dependent) thread class implementation | |
9fc3ad34 | 575 | wxThreadInternal *m_internal; |
10b959e3 | 576 | |
bf1852e1 VZ |
577 | // protects access to any methods of wxThreadInternal object |
578 | wxCriticalSection m_critsect; | |
b568d04f VZ |
579 | |
580 | // true if the thread is detached, false if it is joinable | |
581 | bool m_isDetached; | |
10b959e3 JS |
582 | }; |
583 | ||
78ee6a47 VZ |
584 | // wxThreadHelperThread class |
585 | // -------------------------- | |
586 | ||
587 | class WXDLLIMPEXP_BASE wxThreadHelperThread : public wxThread | |
588 | { | |
589 | public: | |
590 | // constructor only creates the C++ thread object and doesn't create (or | |
591 | // start) the real thread | |
592 | wxThreadHelperThread(wxThreadHelper& owner) | |
593 | : wxThread(wxTHREAD_JOINABLE), m_owner(owner) | |
594 | { } | |
595 | ||
596 | protected: | |
597 | // entry point for the thread -- calls Entry() in owner. | |
598 | virtual void *Entry(); | |
599 | ||
600 | private: | |
601 | // the owner of the thread | |
602 | wxThreadHelper& m_owner; | |
603 | ||
604 | // no copy ctor/assignment operator | |
605 | wxThreadHelperThread(const wxThreadHelperThread&); | |
606 | wxThreadHelperThread& operator=(const wxThreadHelperThread&); | |
607 | }; | |
608 | ||
609 | // ---------------------------------------------------------------------------- | |
610 | // wxThreadHelper: this class implements the threading logic to run a | |
611 | // background task in another object (such as a window). It is a mix-in: just | |
612 | // derive from it to implement a threading background task in your class. | |
613 | // ---------------------------------------------------------------------------- | |
614 | ||
615 | class WXDLLIMPEXP_BASE wxThreadHelper | |
616 | { | |
617 | private: | |
618 | void KillThread() | |
619 | { | |
620 | if ( m_thread ) | |
621 | { | |
622 | m_thread->Kill(); | |
623 | delete m_thread; | |
624 | } | |
625 | } | |
626 | ||
627 | public: | |
628 | // constructor only initializes m_thread to NULL | |
629 | wxThreadHelper() : m_thread(NULL) { } | |
630 | ||
631 | // destructor deletes m_thread | |
632 | virtual ~wxThreadHelper() { KillThread(); } | |
633 | ||
634 | // create a new thread (and optionally set the stack size on platforms that | |
635 | // support/need that), call Run() to start it | |
636 | wxThreadError Create(unsigned int stackSize = 0) | |
637 | { | |
638 | KillThread(); | |
639 | ||
640 | m_thread = new wxThreadHelperThread(*this); | |
641 | ||
642 | return m_thread->Create(stackSize); | |
643 | } | |
644 | ||
645 | // entry point for the thread - called by Run() and executes in the context | |
646 | // of this thread. | |
647 | virtual void *Entry() = 0; | |
648 | ||
649 | // returns a pointer to the thread which can be used to call Run() | |
650 | wxThread *GetThread() const { return m_thread; } | |
651 | ||
652 | protected: | |
653 | wxThread *m_thread; | |
654 | }; | |
655 | ||
656 | // call Entry() in owner, put it down here to avoid circular declarations | |
657 | inline void *wxThreadHelperThread::Entry() | |
658 | { | |
659 | return m_owner.Entry(); | |
660 | } | |
661 | ||
a6b0bd49 | 662 | // ---------------------------------------------------------------------------- |
d524867f | 663 | // Automatic initialization |
a6b0bd49 | 664 | // ---------------------------------------------------------------------------- |
10b959e3 | 665 | |
9d133d87 | 666 | // GUI mutex handling. |
bb24c68f VS |
667 | void WXDLLIMPEXP_BASE wxMutexGuiEnter(); |
668 | void WXDLLIMPEXP_BASE wxMutexGuiLeave(); | |
d524867f | 669 | |
72cdf4c9 VZ |
670 | // macros for entering/leaving critical sections which may be used without |
671 | // having to take them inside "#if wxUSE_THREADS" | |
b568d04f VZ |
672 | #define wxENTER_CRIT_SECT(cs) (cs).Enter() |
673 | #define wxLEAVE_CRIT_SECT(cs) (cs).Leave() | |
bdc72a22 | 674 | #define wxCRIT_SECT_DECLARE(cs) static wxCriticalSection cs |
db882c54 | 675 | #define wxCRIT_SECT_DECLARE_MEMBER(cs) wxCriticalSection cs |
b568d04f | 676 | #define wxCRIT_SECT_LOCKER(name, cs) wxCriticalSectionLocker name(cs) |
72cdf4c9 | 677 | |
17dbd230 VZ |
678 | // function for checking if we're in the main thread which may be used whether |
679 | // wxUSE_THREADS is 0 or 1 | |
680 | inline bool wxIsMainThread() { return wxThread::IsMain(); } | |
681 | ||
9d133d87 | 682 | #else // !wxUSE_THREADS |
d524867f | 683 | |
9d133d87 | 684 | // no thread support |
bb24c68f VS |
685 | inline void WXDLLIMPEXP_BASE wxMutexGuiEnter() { } |
686 | inline void WXDLLIMPEXP_BASE wxMutexGuiLeave() { } | |
d524867f | 687 | |
72cdf4c9 VZ |
688 | // macros for entering/leaving critical sections which may be used without |
689 | // having to take them inside "#if wxUSE_THREADS" | |
690 | #define wxENTER_CRIT_SECT(cs) | |
691 | #define wxLEAVE_CRIT_SECT(cs) | |
bdc72a22 | 692 | #define wxCRIT_SECT_DECLARE(cs) |
db882c54 | 693 | #define wxCRIT_SECT_DECLARE_MEMBER(cs) |
72cdf4c9 VZ |
694 | #define wxCRIT_SECT_LOCKER(name, cs) |
695 | ||
17dbd230 VZ |
696 | // if there is only one thread, it is always the main one |
697 | inline bool wxIsMainThread() { return true; } | |
698 | ||
9e84b847 | 699 | #endif // wxUSE_THREADS/!wxUSE_THREADS |
10b959e3 | 700 | |
4562f685 VZ |
701 | // mark part of code as being a critical section: this macro declares a |
702 | // critical section with the given name and enters it immediately and leaves | |
703 | // it at the end of the current scope | |
704 | // | |
705 | // example: | |
706 | // | |
707 | // int Count() | |
708 | // { | |
709 | // static int s_counter = 0; | |
710 | // | |
711 | // wxCRITICAL_SECTION(counter); | |
712 | // | |
713 | // return ++s_counter; | |
714 | // } | |
715 | // | |
716 | // this function is MT-safe in presence of the threads but there is no | |
717 | // overhead when the library is compiled without threads | |
718 | #define wxCRITICAL_SECTION(name) \ | |
719 | wxCRIT_SECT_DECLARE(s_cs##name); \ | |
720 | wxCRIT_SECT_LOCKER(cs##name##Locker, s_cs##name) | |
721 | ||
9e84b847 | 722 | // automatically lock GUI mutex in ctor and unlock it in dtor |
bb24c68f | 723 | class WXDLLIMPEXP_BASE wxMutexGuiLocker |
bee503b0 VZ |
724 | { |
725 | public: | |
726 | wxMutexGuiLocker() { wxMutexGuiEnter(); } | |
727 | ~wxMutexGuiLocker() { wxMutexGuiLeave(); } | |
728 | }; | |
729 | ||
f6ddc54a VZ |
730 | // ----------------------------------------------------------------------------- |
731 | // implementation only until the end of file | |
732 | // ----------------------------------------------------------------------------- | |
dcda1c71 | 733 | |
9838df2c | 734 | #if wxUSE_THREADS |
dcda1c71 | 735 | |
55034339 | 736 | #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__OS2__) || defined(__EMX__) |
f6ddc54a VZ |
737 | // unlock GUI if there are threads waiting for and lock it back when |
738 | // there are no more of them - should be called periodically by the main | |
739 | // thread | |
bb24c68f | 740 | extern void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter(); |
f6ddc54a | 741 | |
c096f614 | 742 | // returns true if the main thread has GUI lock |
bb24c68f | 743 | extern bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread(); |
f6ddc54a VZ |
744 | |
745 | // wakes up the main thread if it's sleeping inside ::GetMessage() | |
bb24c68f | 746 | extern void WXDLLIMPEXP_BASE wxWakeUpMainThread(); |
bf1852e1 | 747 | |
c096f614 | 748 | // return true if the main thread is waiting for some other to terminate: |
e7549107 | 749 | // wxApp then should block all "dangerous" messages |
bb24c68f | 750 | extern bool WXDLLIMPEXP_BASE wxIsWaitingForThread(); |
9e84b847 | 751 | #endif // MSW, Mac, OS/2 |
dcda1c71 | 752 | |
f6ddc54a VZ |
753 | #endif // wxUSE_THREADS |
754 | ||
9e84b847 | 755 | #endif // _WX_THREAD_H_ |