1998-05-21 11:02:02 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: thread.h
|
|
|
|
// Purpose: Thread API
|
|
|
|
// Author: Guilhem Lavaux
|
1999-01-17 17:39:58 -05:00
|
|
|
// Modified by: Vadim Zeitlin (modifications partly inspired by omnithreads
|
|
|
|
// package from Olivetti & Oracle Research Laboratory)
|
1998-05-21 11:02:02 -04:00
|
|
|
// Created: 04/13/98
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) Guilhem Lavaux
|
|
|
|
// Licence: wxWindows licence
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-18 13:22:15 -04:00
|
|
|
#ifndef __THREADH__
|
|
|
|
#define __THREADH__
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// headers
|
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-17 17:39:58 -05:00
|
|
|
|
|
|
|
// get the value of wxUSE_THREADS configuration flag
|
1998-05-21 11:02:02 -04:00
|
|
|
#include "wx/setup.h"
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
#if wxUSE_THREADS
|
1999-11-24 07:30:56 -05:00
|
|
|
|
|
|
|
// only for wxUSE_THREADS - otherwise we'd get undefined symbols
|
1999-03-11 05:37:09 -05:00
|
|
|
#ifdef __GNUG__
|
|
|
|
#pragma interface "thread.h"
|
|
|
|
#endif
|
1999-01-17 17:39:58 -05:00
|
|
|
|
|
|
|
// Windows headers define it
|
|
|
|
#ifdef Yield
|
|
|
|
#undef Yield
|
|
|
|
#endif
|
|
|
|
|
1999-01-02 17:24:41 -05:00
|
|
|
#include "wx/module.h"
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// constants
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
1999-11-24 07:30:56 -05:00
|
|
|
enum wxMutexError
|
1999-01-02 17:24:41 -05:00
|
|
|
{
|
1999-11-29 18:05:23 -05:00
|
|
|
wxMUTEX_NO_ERROR = 0,
|
|
|
|
wxMUTEX_DEAD_LOCK, // Mutex has been already locked by THE CALLING thread
|
|
|
|
wxMUTEX_BUSY, // Mutex has been already locked by ONE thread
|
|
|
|
wxMUTEX_UNLOCKED,
|
|
|
|
wxMUTEX_MISC_ERROR
|
1999-11-24 07:30:56 -05:00
|
|
|
};
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-11-24 07:30:56 -05:00
|
|
|
enum wxThreadError
|
1999-01-02 17:24:41 -05:00
|
|
|
{
|
1999-11-29 18:05:23 -05:00
|
|
|
wxTHREAD_NO_ERROR = 0, // No error
|
|
|
|
wxTHREAD_NO_RESOURCE, // No resource left to create a new thread
|
|
|
|
wxTHREAD_RUNNING, // The thread is already running
|
|
|
|
wxTHREAD_NOT_RUNNING, // The thread isn't running
|
|
|
|
wxTHREAD_KILLED, // Thread we waited for had to be killed
|
|
|
|
wxTHREAD_MISC_ERROR // Some other error
|
1999-11-24 07:30:56 -05:00
|
|
|
};
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
enum wxThreadKind
|
|
|
|
{
|
|
|
|
wxTHREAD_DETACHED,
|
|
|
|
wxTHREAD_JOINABLE
|
|
|
|
};
|
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// defines the interval of priority
|
1999-11-24 07:30:56 -05:00
|
|
|
enum
|
|
|
|
{
|
|
|
|
WXTHREAD_MIN_PRIORITY = 0u,
|
|
|
|
WXTHREAD_DEFAULT_PRIORITY = 50u,
|
|
|
|
WXTHREAD_MAX_PRIORITY = 100u
|
|
|
|
};
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-02 17:24:41 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-04 22:04:48 -05:00
|
|
|
// A mutex object is a synchronization object whose state is set to signaled
|
|
|
|
// when it is not owned by any thread, and nonsignaled when it is owned. Its
|
|
|
|
// name comes from its usefulness in coordinating mutually-exclusive access to
|
|
|
|
// a shared resource. Only one thread at a time can own a mutex object.
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// you should consider wxMutexLocker whenever possible instead of directly
|
|
|
|
// working with wxMutex class - it is safer
|
1998-08-18 13:22:15 -04:00
|
|
|
class WXDLLEXPORT wxMutexInternal;
|
1999-01-17 17:39:58 -05:00
|
|
|
class WXDLLEXPORT wxMutex
|
1999-01-02 17:24:41 -05:00
|
|
|
{
|
1998-05-21 11:02:02 -04:00
|
|
|
public:
|
1999-01-17 17:39:58 -05:00
|
|
|
// constructor & destructor
|
1999-01-09 19:04:07 -05:00
|
|
|
wxMutex();
|
|
|
|
~wxMutex();
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-09 19:04:07 -05:00
|
|
|
// Lock the mutex.
|
|
|
|
wxMutexError Lock();
|
|
|
|
// Try to lock the mutex: if it can't, returns immediately with an error.
|
|
|
|
wxMutexError TryLock();
|
|
|
|
// Unlock the mutex.
|
|
|
|
wxMutexError Unlock();
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-09 19:04:07 -05:00
|
|
|
// Returns true if the mutex is locked.
|
|
|
|
bool IsLocked() const { return (m_locked > 0); }
|
1998-12-26 19:54:53 -05:00
|
|
|
|
1998-05-21 11:02:02 -04:00
|
|
|
protected:
|
1999-01-09 19:04:07 -05:00
|
|
|
friend class wxCondition;
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-09 19:04:07 -05:00
|
|
|
// no assignment operator nor copy ctor
|
|
|
|
wxMutex(const wxMutex&);
|
|
|
|
wxMutex& operator=(const wxMutex&);
|
|
|
|
|
|
|
|
int m_locked;
|
1999-11-29 18:05:23 -05:00
|
|
|
wxMutexInternal *m_internal;
|
1998-05-21 11:02:02 -04:00
|
|
|
};
|
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// a helper class which locks the mutex in the ctor and unlocks it in the dtor:
|
|
|
|
// this ensures that mutex is always unlocked, even if the function returns or
|
|
|
|
// throws an exception before it reaches the end
|
|
|
|
class WXDLLEXPORT wxMutexLocker
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// lock the mutex in the ctor
|
1999-01-22 11:21:24 -05:00
|
|
|
wxMutexLocker(wxMutex& mutex) : m_mutex(mutex)
|
|
|
|
{ m_isOk = m_mutex.Lock() == wxMUTEX_NO_ERROR; }
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
// returns TRUE if mutex was successfully locked in ctor
|
1999-01-22 11:21:24 -05:00
|
|
|
bool IsOk() const
|
|
|
|
{ return m_isOk; }
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
// unlock the mutex in dtor
|
1999-01-22 11:21:24 -05:00
|
|
|
~wxMutexLocker()
|
|
|
|
{ if ( IsOk() ) m_mutex.Unlock(); }
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
private:
|
1999-01-09 19:04:07 -05:00
|
|
|
// no assignment operator nor copy ctor
|
|
|
|
wxMutexLocker(const wxMutexLocker&);
|
|
|
|
wxMutexLocker& operator=(const wxMutexLocker&);
|
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
bool m_isOk;
|
1999-01-22 11:21:24 -05:00
|
|
|
wxMutex& m_mutex;
|
1999-01-04 22:04:48 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// Critical section: this is the same as mutex but is only visible to the
|
|
|
|
// threads of the same process. For the platforms which don't have native
|
|
|
|
// support for critical sections, they're implemented entirely in terms of
|
1999-11-24 07:30:56 -05:00
|
|
|
// mutexes.
|
|
|
|
//
|
|
|
|
// NB: wxCriticalSection object does not allocate any memory in its ctor
|
|
|
|
// which makes it possible to have static globals of this class
|
1999-01-04 22:04:48 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
1999-11-24 07:30:56 -05:00
|
|
|
class WXDLLEXPORT wxCriticalSectionInternal;
|
|
|
|
|
|
|
|
// in order to avoid any overhead under platforms where critical sections are
|
|
|
|
// just mutexes make all wxCriticalSection class functions inline
|
2000-08-14 04:15:51 -04:00
|
|
|
#if !defined(__WXMSW__) && !defined(__WXPM__)
|
1999-01-11 10:51:45 -05:00
|
|
|
#define WXCRITICAL_INLINE inline
|
1999-11-24 07:30:56 -05:00
|
|
|
|
|
|
|
#define wxCRITSECT_IS_MUTEX 1
|
2000-08-14 04:15:51 -04:00
|
|
|
#else // MSW || OS2
|
1999-11-24 07:30:56 -05:00
|
|
|
#define WXCRITICAL_INLINE
|
|
|
|
|
|
|
|
#define wxCRITSECT_IS_MUTEX 0
|
1999-01-11 10:51:45 -05:00
|
|
|
#endif // MSW/!MSW
|
1999-01-17 17:39:58 -05:00
|
|
|
|
|
|
|
// you should consider wxCriticalSectionLocker whenever possible instead of
|
|
|
|
// directly working with wxCriticalSection class - it is safer
|
1999-01-04 22:04:48 -05:00
|
|
|
class WXDLLEXPORT wxCriticalSection
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// ctor & dtor
|
1999-01-11 10:51:45 -05:00
|
|
|
WXCRITICAL_INLINE wxCriticalSection();
|
|
|
|
WXCRITICAL_INLINE ~wxCriticalSection();
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
// enter the section (the same as locking a mutex)
|
1999-03-05 11:24:07 -05:00
|
|
|
WXCRITICAL_INLINE void Enter();
|
1999-01-04 22:04:48 -05:00
|
|
|
// leave the critical section (same as unlocking a mutex)
|
1999-03-05 11:24:07 -05:00
|
|
|
WXCRITICAL_INLINE void Leave();
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
private:
|
1999-01-09 19:04:07 -05:00
|
|
|
// no assignment operator nor copy ctor
|
|
|
|
wxCriticalSection(const wxCriticalSection&);
|
|
|
|
wxCriticalSection& operator=(const wxCriticalSection&);
|
|
|
|
|
1999-11-24 07:30:56 -05:00
|
|
|
#if wxCRITSECT_IS_MUTEX
|
1999-01-11 10:51:45 -05:00
|
|
|
wxMutex m_mutex;
|
1999-11-24 07:30:56 -05:00
|
|
|
#elif defined(__WXMSW__)
|
|
|
|
// we can't allocate any memory in the ctor, so use placement new -
|
|
|
|
// unfortunately, we have to hardcode the sizeof() here because we can't
|
|
|
|
// include windows.h from this public header
|
|
|
|
char m_buffer[24];
|
|
|
|
#elif !defined(__WXPM__)
|
|
|
|
wxCriticalSectionInternal *m_critsect;
|
|
|
|
#else
|
|
|
|
// nothing for OS/2
|
|
|
|
#endif // !Unix/Unix
|
1999-01-04 22:04:48 -05:00
|
|
|
};
|
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// keep your preprocessor name space clean
|
|
|
|
#undef WXCRITICAL_INLINE
|
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
|
|
|
|
// to th mutexes
|
|
|
|
class WXDLLEXPORT wxCriticalSectionLocker
|
|
|
|
{
|
|
|
|
public:
|
1999-11-09 09:32:40 -05:00
|
|
|
inline wxCriticalSectionLocker(wxCriticalSection& critsect);
|
|
|
|
inline ~wxCriticalSectionLocker();
|
1999-01-04 22:04:48 -05:00
|
|
|
|
|
|
|
private:
|
1999-01-09 19:04:07 -05:00
|
|
|
// no assignment operator nor copy ctor
|
|
|
|
wxCriticalSectionLocker(const wxCriticalSectionLocker&);
|
|
|
|
wxCriticalSectionLocker& operator=(const wxCriticalSectionLocker&);
|
|
|
|
|
1999-01-08 19:28:27 -05:00
|
|
|
wxCriticalSection& m_critsect;
|
1999-01-04 22:04:48 -05:00
|
|
|
};
|
|
|
|
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-11-29 18:05:23 -05:00
|
|
|
// Condition variable: allows to block the thread execution until something
|
|
|
|
// happens (== condition is signaled)
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1998-05-21 11:02:02 -04:00
|
|
|
class wxConditionInternal;
|
1999-01-17 17:39:58 -05:00
|
|
|
class WXDLLEXPORT wxCondition
|
1999-01-02 17:24:41 -05:00
|
|
|
{
|
1998-05-21 11:02:02 -04:00
|
|
|
public:
|
1999-11-29 18:05:23 -05:00
|
|
|
// constructor & destructor
|
|
|
|
wxCondition();
|
|
|
|
~wxCondition();
|
|
|
|
|
|
|
|
// wait until the condition is signaled
|
|
|
|
// waits indefinitely.
|
|
|
|
void Wait();
|
|
|
|
// waits until a signal is raised or the timeout elapses
|
|
|
|
bool Wait(unsigned long sec, unsigned long nsec);
|
|
|
|
|
|
|
|
// signal the condition
|
|
|
|
// wakes up one (and only one) of the waiting threads
|
|
|
|
void Signal();
|
|
|
|
// wakes up all threads waiting onthis condition
|
|
|
|
void Broadcast();
|
1998-12-26 19:54:53 -05:00
|
|
|
|
1998-05-21 11:02:02 -04:00
|
|
|
private:
|
1999-11-29 18:05:23 -05:00
|
|
|
wxConditionInternal *m_internal;
|
1998-05-21 11:02:02 -04:00
|
|
|
};
|
|
|
|
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-11-27 17:57:06 -05:00
|
|
|
// Thread class
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// there are two different kinds of threads: joinable and detached (default)
|
|
|
|
// ones. Only joinable threads can return a return code and only detached
|
|
|
|
// threads auto-delete themselves - the user should delete the joinable
|
|
|
|
// threads manually.
|
1999-01-17 17:39:58 -05:00
|
|
|
|
|
|
|
// NB: in the function descriptions the words "this thread" mean the thread
|
|
|
|
// created by the wxThread object while "main thread" is the thread created
|
|
|
|
// during the process initialization (a.k.a. the GUI thread)
|
1999-11-27 17:57:06 -05:00
|
|
|
|
1998-05-21 11:02:02 -04:00
|
|
|
class wxThreadInternal;
|
1999-01-17 17:39:58 -05:00
|
|
|
class WXDLLEXPORT wxThread
|
1999-01-02 17:24:41 -05:00
|
|
|
{
|
1998-05-21 11:02:02 -04:00
|
|
|
public:
|
1999-01-17 17:39:58 -05:00
|
|
|
// the return type for the thread function
|
|
|
|
typedef void *ExitCode;
|
|
|
|
|
|
|
|
// static functions
|
|
|
|
// Returns the wxThread object for the calling thread. NULL is returned
|
|
|
|
// if the caller is the main thread (but it's recommended to use
|
|
|
|
// IsMain() and only call This() for threads other than the main one
|
|
|
|
// because NULL is also returned on error). If the thread wasn't
|
|
|
|
// created with wxThread class, the returned value is undefined.
|
|
|
|
static wxThread *This();
|
|
|
|
|
|
|
|
// Returns true if current thread is the main thread.
|
|
|
|
static bool IsMain();
|
|
|
|
|
|
|
|
// Release the rest of our time slice leting the other threads run
|
|
|
|
static void Yield();
|
|
|
|
|
|
|
|
// Sleep during the specified period of time in milliseconds
|
|
|
|
//
|
|
|
|
// NB: at least under MSW worker threads can not call ::wxSleep()!
|
|
|
|
static void Sleep(unsigned long milliseconds);
|
|
|
|
|
1999-12-06 07:31:04 -05:00
|
|
|
// get the number of system CPUs - useful with SetConcurrency()
|
|
|
|
// (the "best" value for it is usually number of CPUs + 1)
|
|
|
|
//
|
|
|
|
// Returns -1 if unknown, number of CPUs otherwise
|
|
|
|
static int GetCPUCount();
|
|
|
|
|
|
|
|
// sets the concurrency level: this is, roughly, the number of threads
|
|
|
|
// the system tries to schedule to run in parallel. 0 means the
|
|
|
|
// default value (usually acceptable, but may not yield the best
|
|
|
|
// performance for this process)
|
|
|
|
//
|
|
|
|
// Returns TRUE on success, FALSE otherwise (if not implemented, for
|
|
|
|
// example)
|
|
|
|
static bool SetConcurrency(size_t level);
|
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// constructor only creates the C++ thread object and doesn't create (or
|
|
|
|
// start) the real thread
|
|
|
|
wxThread(wxThreadKind kind = wxTHREAD_DETACHED);
|
|
|
|
|
|
|
|
// functions that change the thread state: all these can only be called
|
|
|
|
// from _another_ thread (typically the thread that created this one, e.g.
|
|
|
|
// the main thread), not from the thread itself
|
1999-01-17 17:39:58 -05:00
|
|
|
|
2002-01-03 00:53:39 -05:00
|
|
|
// create a new thread and optionally set the stack size on
|
|
|
|
// platforms that support that - call Run() to start it
|
|
|
|
// (special cased for watcom which won't accept 0 default)
|
|
|
|
|
|
|
|
wxThreadError Create(unsigned int stackSize = 0);
|
1999-01-17 17:39:58 -05:00
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// starts execution of the thread - from the moment Run() is called
|
|
|
|
// the execution of wxThread::Entry() may start at any moment, caller
|
1999-01-17 17:39:58 -05:00
|
|
|
// shouldn't suppose that it starts after (or before) Run() returns.
|
|
|
|
wxThreadError Run();
|
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// stops the thread if it's running and deletes the wxThread object if
|
|
|
|
// this is a detached thread freeing its memory - otherwise (for
|
|
|
|
// joinable threads) you still need to delete wxThread object
|
|
|
|
// yourself.
|
|
|
|
//
|
|
|
|
// this function only works if the thread calls TestDestroy()
|
|
|
|
// periodically - the thread will only be deleted the next time it
|
|
|
|
// does it!
|
|
|
|
//
|
|
|
|
// will fill the rc pointer with the thread exit code if it's !NULL
|
|
|
|
wxThreadError Delete(ExitCode *rc = (ExitCode *)NULL);
|
|
|
|
|
|
|
|
// waits for a joinable thread to finish and returns its exit code
|
|
|
|
//
|
|
|
|
// Returns (ExitCode)-1 on error (for example, if the thread is not
|
|
|
|
// joinable)
|
|
|
|
ExitCode Wait();
|
1999-01-17 17:39:58 -05:00
|
|
|
|
|
|
|
// kills the thread without giving it any chance to clean up - should
|
|
|
|
// not be used in normal circumstances, use Delete() instead. It is a
|
|
|
|
// dangerous function that should only be used in the most extreme
|
1999-11-27 17:57:06 -05:00
|
|
|
// cases!
|
|
|
|
//
|
|
|
|
// The wxThread object is deleted by Kill() if the thread is
|
|
|
|
// detachable, but you still have to delete it manually for joinable
|
|
|
|
// threads.
|
1999-01-17 17:39:58 -05:00
|
|
|
wxThreadError Kill();
|
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// pause a running thread: as Delete(), this only works if the thread
|
|
|
|
// calls TestDestroy() regularly
|
1999-01-17 17:39:58 -05:00
|
|
|
wxThreadError Pause();
|
|
|
|
|
|
|
|
// resume a paused thread
|
|
|
|
wxThreadError Resume();
|
|
|
|
|
|
|
|
// priority
|
|
|
|
// Sets the priority to "prio": see WXTHREAD_XXX_PRIORITY constants
|
|
|
|
//
|
|
|
|
// NB: the priority can only be set before the thread is created
|
|
|
|
void SetPriority(unsigned int prio);
|
|
|
|
|
|
|
|
// Get the current priority.
|
|
|
|
unsigned int GetPriority() const;
|
|
|
|
|
|
|
|
// thread status inquiries
|
|
|
|
// Returns true if the thread is alive: i.e. running or suspended
|
|
|
|
bool IsAlive() const;
|
|
|
|
// Returns true if the thread is running (not paused, not killed).
|
|
|
|
bool IsRunning() const;
|
|
|
|
// Returns true if the thread is suspended
|
1999-04-26 14:16:56 -04:00
|
|
|
bool IsPaused() const;
|
1999-01-17 17:39:58 -05:00
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// is the thread of detached kind?
|
|
|
|
bool IsDetached() const { return m_isDetached; }
|
|
|
|
|
|
|
|
// Get the thread ID - a platform dependent number which uniquely
|
|
|
|
// identifies a thread inside a process
|
2001-10-05 07:10:29 -04:00
|
|
|
#ifdef __VMS
|
|
|
|
unsigned long long GetId() const;
|
|
|
|
#else
|
|
|
|
unsigned long GetId() const;
|
|
|
|
#endif
|
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// called when the thread exits - in the context of this thread
|
|
|
|
//
|
|
|
|
// NB: this function will not be called if the thread is Kill()ed
|
|
|
|
virtual void OnExit() { }
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-11-27 17:57:06 -05:00
|
|
|
// dtor is public, but the detached threads should never be deleted - use
|
|
|
|
// Delete() instead (or leave the thread terminate by itself)
|
|
|
|
virtual ~wxThread();
|
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
protected:
|
|
|
|
// Returns TRUE if the thread was asked to terminate: this function should
|
|
|
|
// be called by the thread from time to time, otherwise the main thread
|
|
|
|
// will be left forever in Delete()!
|
1999-01-22 13:35:42 -05:00
|
|
|
bool TestDestroy();
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// exits from the current thread - can be called only from this thread
|
1999-11-27 17:57:06 -05:00
|
|
|
void Exit(ExitCode exitcode = 0);
|
1999-01-04 22:04:48 -05:00
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// entry point for the thread - called by Run() and executes in the context
|
|
|
|
// of this thread.
|
|
|
|
virtual void *Entry() = 0;
|
1998-12-26 19:54:53 -05:00
|
|
|
|
1998-05-21 11:02:02 -04:00
|
|
|
private:
|
1999-01-17 17:39:58 -05:00
|
|
|
// no copy ctor/assignment operator
|
|
|
|
wxThread(const wxThread&);
|
|
|
|
wxThread& operator=(const wxThread&);
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
friend class wxThreadInternal;
|
|
|
|
|
|
|
|
// the (platform-dependent) thread class implementation
|
1999-11-29 18:05:23 -05:00
|
|
|
wxThreadInternal *m_internal;
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// protects access to any methods of wxThreadInternal object
|
|
|
|
wxCriticalSection m_critsect;
|
1999-11-27 17:57:06 -05:00
|
|
|
|
|
|
|
// true if the thread is detached, false if it is joinable
|
|
|
|
bool m_isDetached;
|
1998-05-21 11:02:02 -04:00
|
|
|
};
|
|
|
|
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1999-01-02 17:24:41 -05:00
|
|
|
// Automatic initialization
|
1998-12-26 19:54:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// GUI mutex handling.
|
|
|
|
void WXDLLEXPORT wxMutexGuiEnter();
|
|
|
|
void WXDLLEXPORT wxMutexGuiLeave();
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1999-10-18 11:14:52 -04:00
|
|
|
// macros for entering/leaving critical sections which may be used without
|
|
|
|
// having to take them inside "#if wxUSE_THREADS"
|
1999-11-27 17:57:06 -05:00
|
|
|
#define wxENTER_CRIT_SECT(cs) (cs).Enter()
|
|
|
|
#define wxLEAVE_CRIT_SECT(cs) (cs).Leave()
|
1999-12-04 17:34:54 -05:00
|
|
|
#define wxCRIT_SECT_DECLARE(cs) static wxCriticalSection cs
|
1999-11-27 17:57:06 -05:00
|
|
|
#define wxCRIT_SECT_LOCKER(name, cs) wxCriticalSectionLocker name(cs)
|
1999-10-18 11:14:52 -04:00
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
#else // !wxUSE_THREADS
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1999-08-20 18:52:21 -04:00
|
|
|
#include "wx/defs.h" // for WXDLLEXPORT
|
1999-03-05 19:11:27 -05:00
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
// no thread support
|
|
|
|
inline void WXDLLEXPORT wxMutexGuiEnter() { }
|
|
|
|
inline void WXDLLEXPORT wxMutexGuiLeave() { }
|
1999-01-02 17:24:41 -05:00
|
|
|
|
1999-10-18 11:14:52 -04:00
|
|
|
// macros for entering/leaving critical sections which may be used without
|
|
|
|
// having to take them inside "#if wxUSE_THREADS"
|
|
|
|
#define wxENTER_CRIT_SECT(cs)
|
|
|
|
#define wxLEAVE_CRIT_SECT(cs)
|
1999-12-04 17:34:54 -05:00
|
|
|
#define wxCRIT_SECT_DECLARE(cs)
|
1999-10-18 11:14:52 -04:00
|
|
|
#define wxCRIT_SECT_LOCKER(name, cs)
|
|
|
|
|
1999-01-04 22:04:48 -05:00
|
|
|
#endif // wxUSE_THREADS
|
1998-05-21 11:02:02 -04:00
|
|
|
|
1999-01-08 19:28:27 -05:00
|
|
|
// automatically unlock GUI mutex in dtor
|
|
|
|
class WXDLLEXPORT wxMutexGuiLocker
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxMutexGuiLocker() { wxMutexGuiEnter(); }
|
|
|
|
~wxMutexGuiLocker() { wxMutexGuiLeave(); }
|
|
|
|
};
|
|
|
|
|
1999-01-11 10:51:45 -05:00
|
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// implementation only until the end of file
|
|
|
|
// -----------------------------------------------------------------------------
|
1999-11-09 09:32:40 -05:00
|
|
|
|
1999-01-24 09:57:09 -05:00
|
|
|
#if wxUSE_THREADS
|
1999-11-09 09:32:40 -05:00
|
|
|
|
1999-11-01 23:37:45 -05:00
|
|
|
#if defined(__WXMSW__)
|
1999-01-11 10:51:45 -05:00
|
|
|
// unlock GUI if there are threads waiting for and lock it back when
|
|
|
|
// there are no more of them - should be called periodically by the main
|
|
|
|
// thread
|
1999-01-12 18:39:07 -05:00
|
|
|
extern void WXDLLEXPORT wxMutexGuiLeaveOrEnter();
|
1999-01-11 10:51:45 -05:00
|
|
|
|
|
|
|
// returns TRUE if the main thread has GUI lock
|
1999-01-12 18:39:07 -05:00
|
|
|
extern bool WXDLLEXPORT wxGuiOwnedByMainThread();
|
1999-01-11 10:51:45 -05:00
|
|
|
|
|
|
|
// wakes up the main thread if it's sleeping inside ::GetMessage()
|
1999-01-12 18:39:07 -05:00
|
|
|
extern void WXDLLEXPORT wxWakeUpMainThread();
|
1999-01-17 17:39:58 -05:00
|
|
|
|
1999-11-09 10:24:52 -05:00
|
|
|
// return TRUE if the main thread is waiting for some other to terminate:
|
|
|
|
// wxApp then should block all "dangerous" messages
|
|
|
|
extern bool WXDLLEXPORT wxIsWaitingForThread();
|
|
|
|
#elif defined(__WXMAC__)
|
2000-08-14 04:15:51 -04:00
|
|
|
extern void WXDLLEXPORT wxMutexGuiLeaveOrEnter();
|
1999-11-09 10:24:52 -05:00
|
|
|
|
|
|
|
// returns TRUE if the main thread has GUI lock
|
|
|
|
extern bool WXDLLEXPORT wxGuiOwnedByMainThread();
|
|
|
|
|
|
|
|
// wakes up the main thread if it's sleeping inside ::GetMessage()
|
|
|
|
extern void WXDLLEXPORT wxWakeUpMainThread();
|
|
|
|
|
1999-01-17 17:39:58 -05:00
|
|
|
// return TRUE if the main thread is waiting for some other to terminate:
|
|
|
|
// wxApp then should block all "dangerous" messages
|
|
|
|
extern bool WXDLLEXPORT wxIsWaitingForThread();
|
2000-08-14 04:15:51 -04:00
|
|
|
|
|
|
|
// implement wxCriticalSection using mutexes
|
|
|
|
inline wxCriticalSection::wxCriticalSection() { }
|
|
|
|
inline wxCriticalSection::~wxCriticalSection() { }
|
|
|
|
|
|
|
|
inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
|
|
|
|
inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
|
1999-11-01 23:37:45 -05:00
|
|
|
#elif defined(__WXPM__)
|
|
|
|
// unlock GUI if there are threads waiting for and lock it back when
|
|
|
|
// there are no more of them - should be called periodically by the main
|
|
|
|
// thread
|
|
|
|
extern void WXDLLEXPORT wxMutexGuiLeaveOrEnter();
|
|
|
|
|
|
|
|
// returns TRUE if the main thread has GUI lock
|
|
|
|
extern bool WXDLLEXPORT wxGuiOwnedByMainThread();
|
1999-11-22 00:27:57 -05:00
|
|
|
|
1999-11-14 23:48:33 -05:00
|
|
|
// return TRUE if the main thread is waiting for some other to terminate:
|
|
|
|
// wxApp then should block all "dangerous" messages
|
|
|
|
extern bool WXDLLEXPORT wxIsWaitingForThread();
|
1999-11-22 00:27:57 -05:00
|
|
|
|
1999-11-01 23:37:45 -05:00
|
|
|
#else // !MSW && !PM
|
1999-01-11 10:51:45 -05:00
|
|
|
// implement wxCriticalSection using mutexes
|
|
|
|
inline wxCriticalSection::wxCriticalSection() { }
|
|
|
|
inline wxCriticalSection::~wxCriticalSection() { }
|
|
|
|
|
|
|
|
inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
|
|
|
|
inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
|
|
|
|
#endif // MSW/!MSW
|
1999-11-09 09:32:40 -05:00
|
|
|
|
|
|
|
// we can define these inline functions now (they should be defined after
|
|
|
|
// wxCriticalSection::Enter/Leave)
|
|
|
|
inline
|
|
|
|
wxCriticalSectionLocker:: wxCriticalSectionLocker(wxCriticalSection& cs)
|
|
|
|
: m_critsect(cs) { m_critsect.Enter(); }
|
|
|
|
inline
|
|
|
|
wxCriticalSectionLocker::~wxCriticalSectionLocker() { m_critsect.Leave(); }
|
1999-01-11 10:51:45 -05:00
|
|
|
#endif // wxUSE_THREADS
|
|
|
|
|
1998-12-26 19:54:53 -05:00
|
|
|
#endif // __THREADH__
|
2002-01-03 00:53:39 -05:00
|
|
|
|
|
|
|
// vi:sts=4:sw=4:et
|