* Renamed fstream.h in wfstream.h

[wxWidgets.git] / include / wx / thread.h

diff --git a/include/wx/thread.h b/include/wx/thread.h
index 1041ed5db740b0ff6860475effc9779193a3cd19..99091a44abdaa58a749be6fa6beb8bfceb1c8f22 100644 (file)
--- a/include/wx/thread.h
+++ b/include/wx/thread.h
@@ -22,14 +22,16 @@
 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
+  MUTEX_BUSY,                  // Mutex has been already locked by ONE thread
+  MUTEX_UNLOCKED
 } 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
+  THREAD_NOT_RUNNING,          // The thread isn't running
+  THREAD_MISC_ERROR             // Some other error
 } wxThreadError;
 
 // defines the interval of priority.
@@ -39,22 +41,22 @@ typedef enum {
 
 // ---------------------------------------------------------------------------
 // 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;
 
@@ -68,17 +70,17 @@ 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;
 };
@@ -89,46 +91,57 @@ 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 flag DIFFER isn't true.
-  wxThreadError Destroy(void);
+  // Destroys the thread immediately if the defer flag isn't true.
+  wxThreadError Destroy();
 
-  // Switches on the DIFFER flag.
+  // Pause a running thread
+  wxThreadError Pause();
+
+  // Resume a paused thread
+  wxThreadError Resume();
+
+  // 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 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();
+
+  // Returns the wxThread object which corresponds to the ID.
+  static wxThread *GetThreadFromID(unsigned long id);
 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;
@@ -139,7 +152,8 @@ private:
 // ---------------------------------------------------------------------------
 // Global variables
 
-// GUI mutex.
-WXDLLEXPORT_DATA(extern wxMutex) wxMainMutex;
+// GUI mutex handling.
+void WXDLLEXPORT wxMutexGuiEnter();
+void WXDLLEXPORT wxMutexGuiLeave();
 
 #endif