+ // 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);
+
+ // 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();
+
+ // Get the platform specific thread ID and return as a long. This
+ // can be used to uniquely identify threads, even if they are not
+ // wxThreads. This is used by wxPython.
+ // On VMS thread pointers are 64 bits (also needed for other systems???
+#ifdef __VMS
+ static unsigned long long GetCurrentId();
+#else
+ static unsigned long GetCurrentId();
+#endif
+
+ // 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);
+
+ // 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
+
+ // 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);
+
+ // starts execution of the thread - from the moment Run() is called
+ // the execution of wxThread::Entry() may start at any moment, caller
+ // shouldn't suppose that it starts after (or before) Run() returns.
+ wxThreadError Run();
+
+ // 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();
+
+ // 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
+ // cases!
+ //
+ // The wxThread object is deleted by Kill() if the thread is
+ // detachable, but you still have to delete it manually for joinable
+ // threads.
+ wxThreadError Kill();
+
+ // pause a running thread: as Delete(), this only works if the thread
+ // calls TestDestroy() regularly
+ 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
+ bool IsPaused() const;
+
+ // 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
+#ifdef __VMS
+ unsigned long long GetId() const;
+#else
+ unsigned long GetId() const;
+#endif