#pragma interface "thread.h"
#endif
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
#include "wx/object.h"
#include "wx/setup.h"
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
typedef enum {
- MUTEX_NO_ERROR=0,
- MUTEX_DEAD_LOCK, // Mutex has been already locked by THE CALLING thread
- MUTEX_BUSY // Mutex has been already locked by ONE thread
+ 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
} wxMutexError;
typedef enum {
- THREAD_NO_ERROR=0, // No error
- THREAD_NO_RESOURCE, // No resource left to create a new thread
- THREAD_RUNNING, // The thread is already running
- THREAD_NOT_RUNNING // The thread isn't running
+ 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_MISC_ERROR // Some other error
} wxThreadError;
// defines the interval of priority.
-#define WXTHREAD_MIN_PRIORITY 0
+#define WXTHREAD_MIN_PRIORITY 0
#define WXTHREAD_DEFAULT_PRIORITY 50
-#define WXTHREAD_MAX_PRIORITY 100
+#define WXTHREAD_MAX_PRIORITY 100
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
// Mutex handler
-class wxMutexInternal;
+// ----------------------------------------------------------------------------
+class WXDLLEXPORT wxMutexInternal;
class WXDLLEXPORT wxMutex {
public:
// constructor & destructor
- wxMutex(void);
- ~wxMutex(void);
+ wxMutex();
+ ~wxMutex();
// Lock the mutex.
- wxMutexError Lock(void);
+ wxMutexError Lock();
// Try to lock the mutex: if it can't, returns immediately with an error.
- wxMutexError TryLock(void);
+ wxMutexError TryLock();
// Unlock the mutex.
- wxMutexError Unlock(void);
+ wxMutexError Unlock();
// Returns true if the mutex is locked.
- bool IsLocked(void) { return (m_locked > 0); }
+ bool IsLocked() const { return (m_locked > 0); }
+
protected:
friend class wxCondition;
wxMutexInternal *p_internal;
};
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
// Condition handler.
+// ----------------------------------------------------------------------------
class wxConditionInternal;
class WXDLLEXPORT wxCondition {
public:
// constructor & destructor
- wxCondition(void);
- ~wxCondition(void);
+ wxCondition();
+ ~wxCondition();
- // Waits undefinitely.
+ // Waits indefinitely.
void Wait(wxMutex& mutex);
// Waits until a signal is raised or the timeout is elapsed.
bool Wait(wxMutex& mutex, unsigned long sec, unsigned long nsec);
// Raises a signal: only one "Waiter" is released.
- void Signal(void);
+ void Signal();
// Broadcasts to all "Waiters".
- void Broadcast(void);
+ void Broadcast();
+
private:
wxConditionInternal *p_internal;
};
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
// Thread management class
+// ----------------------------------------------------------------------------
class wxThreadInternal;
class WXDLLEXPORT wxThread {
public:
// constructor & destructor.
- wxThread(void);
- virtual ~wxThread(void);
+ wxThread();
+ virtual ~wxThread();
// Create a new thread, this method should check there is only one thread
// running by object.
- wxThreadError Create(void);
+ wxThreadError Create();
+
+ // Destroys the thread immediately if the defer flag isn't true.
+ wxThreadError Destroy();
+
+ // Pause a running thread
+ wxThreadError Pause();
- // Destroys the thread immediately if the flag DIFFER isn't true.
- wxThreadError Destroy(void);
+ // Resume a paused thread
+ wxThreadError Resume();
- // Switches on the DIFFER flag.
+ // Switches on the defer flag.
void DeferDestroy(bool on);
// Waits for the termination of the thread.
- void *Join(void);
+ void *Join();
// Sets the priority to "prio". (Warning: The priority can only be set before
// the thread is created)
void SetPriority(int prio);
// Get the current priority.
- int GetPriority(void);
+ int GetPriority() const;
// Get the thread ID
- unsigned long GetID(void);
+ unsigned long GetID() const;
// Returns true if the thread is alive.
- bool IsAlive(void);
+ bool IsAlive() const;
+ // Returns true if the thread is running (not paused, not killed).
+ bool IsRunning() const;
+ // Returns true if the thread is suspended
+ bool IsPaused() const { return IsAlive() && !IsRunning(); }
+
// Returns true if the thread is the main thread (aka the GUI thread).
- static bool IsMain(void);
+ static bool IsMain();
// Called when thread exits.
- virtual void OnExit(void);
+ virtual void OnExit();
+
protected:
// In case, the DIFFER flag is true, enables another thread to kill this one.
- void TestDestroy(void);
+ void TestDestroy();
// Exits from the current thread.
void Exit(void *status = NULL);
+
private:
// Entry point for the thread.
- virtual void *Entry(void) = 0;
+ virtual void *Entry() = 0;
private:
friend class wxThreadInternal;
wxThreadInternal *p_internal;
};
-// ---------------------------------------------------------------------------
-// Global variables
+// ----------------------------------------------------------------------------
+// Global functions and variables
+// ----------------------------------------------------------------------------
-// GUI mutex.
-WXDLLEXPORT_DATA(extern wxMutex) wxMainMutex;
+// GUI mutex handling.
+void WXDLLEXPORT wxMutexGuiEnter();
+void WXDLLEXPORT wxMutexGuiLeave();
-#endif
+#endif // __THREADH__
projects / wxWidgets.git / blobdiff