## wxThread

A thread is basically a path of execution through a program. Threads are sometimes called light-weight processes, but the fundamental difference between threads and processes is that memory spaces of different processes are separated while all threads share the same address space.

While it makes it much easier to share common data between several threads, it also makes it much easier to shoot oneself in the foot, so careful use of synchronization objects such as mutexes or critical sections is recommended. In addition, don't create global thread objects because they allocate memory in their constructor, which will cause problems for the memory checking system.

Derived from

None.

Include files

<wx/thread.h>

See also

wxMutex, wxCondition, wxCriticalSection

Members

Types of wxThreads
wxThread deletion
wxWidgets calls in secondary threads
Don't poll a wxThread
wxThread::wxThread
wxThread::~wxThread
wxThread::Create
wxThread::Delete
wxThread::Entry
wxThread::Exit
wxThread::GetCPUCount
wxThread::GetCurrentId
wxThread::GetId
wxThread::GetPriority
wxThread::IsAlive
wxThread::IsDetached
wxThread::IsMain
wxThread::IsPaused
wxThread::IsRunning
wxThread::Kill
wxThread::OnExit
wxThread::Pause
wxThread::Run
wxThread::SetPriority
wxThread::Sleep
wxThread::Resume
wxThread::SetConcurrency
wxThread::TestDestroy
wxThread::This
wxThread::Yield
wxThread::Wait

### Types of wxThreads

There are two types of threads in wxWidgets: detached and joinable, modeled after the the POSIX thread API. This is different from the Win32 API where all threads are joinable.

By default wxThreads in wxWidgets use the detached behavior. Detached threads delete themselves once they have completed, either by themselves when they complete processing or through a call to wxThread::Delete, and thus must be created on the heap (through the new operator, for example). Conversely, joinable threads do not delete themselves when they are done processing and as such are safe to create on the stack. Joinable threads also provide the ability for one to get value it returned from wxThread::Entry through wxThread::Wait.

You shouldn't hurry to create all the threads joinable, however, because this has a disadvantage as well: you must Wait() for a joinable thread or the system resources used by it will never be freed, and you also must delete the corresponding wxThread object yourself if you did not create it on the stack. In contrast, detached threads are of the "fire-and-forget" kind: you only have to start a detached thread and it will terminate and destroy itself.

### wxThread deletion

Regardless of whether it has terminated or not, you should call wxThread::Wait on a joinable thread to release its memory, as outlined in Types of wxThreads. If you created a joinable thread on the heap, remember to delete it manually with the delete operator or similar means as only detached threads handle this type of memory management.

Since detached threads delete themselves when they are finished processing, you should take care when calling a routine on one. If you are certain the thread is still running and would like to end it, you may call wxThread::Delete to gracefully end it (which implies that the thread will be deleted after that call to Delete()). It should be implied that you should never attempt to delete a detached thread with the delete operator or similar means.

As mentioned, wxThread::Wait or wxThread::Delete attempts to gracefully terminate a joinable and detached thread, respectively. It does this by waiting until the thread in question calls wxThread::TestDestroy or ends processing (returns from wxThread::Entry).

Obviously, if the thread does call TestDestroy() and does not end the calling thread will come to halt. This is why it is important to call TestDestroy() in the Entry() routine of your threads as often as possible.

As a last resort you can end the thread immediately through wxThread::Kill. It is strongly recommended that you do not do this, however, as it does not free the resources associated with the object (although the wxThread object of detached threads will still be deleted) and could leave the C runtime library in an undefined state.

### wxWidgets calls in secondary threads

All threads other then the "main application thread" (the one wxApp::OnInit or your main function runs in, for example) are considered "secondary threads". These include all threads created by wxThread::Create or the corresponding constructors.

GUI calls, such as those to a wxWindow or wxBitmap are explicitly not safe at all in secondary threads and could end your application prematurely. This is due to several reasons, including the underlying native API and the fact that wxThread does not run a GUI event loop similar to other APIs as MFC.

A workaround that works on some wxWidgets ports is calling wxMutexGUIEnter before any GUI calls and then calling wxMutexGUILeave afterwords. However, the recommended way is to simply process the GUI calls in the main thread through an event that is posted by either wxPostEvent or wxEvtHandler::AddPendingEvent. This does not imply that calls to these classes are thread-safe, however, as most wxWidgets classes are not thread-safe, including wxString.

### Don't poll a wxThread

A common problem users experience with wxThread is that in their main thread they will check the thread every now and then to see if it has ended through wxThread::IsRunning, only to find that their application has run into problems because the thread is using the default behavior and has already deleted itself. Naturally, they instead attempt to use joinable threads in place of the previous behavior.

However, polling a wxThread for when it has ended is in general a bad idea - in fact calling a routine on any running wxThread should be avoided if possible. Instead, find a way to notify yourself when the thread has ended. Usually you only need to notify the main thread, in which case you can post an event to it via wxPostEvent or wxEvtHandler::AddPendingEvent. In the case of secondary threads you can call a routine of another class when the thread is about to complete processing and/or set the value of a variable, possibly using mutexes and/or other synchronization means if necessary.

### wxThread::wxThread

wxThread(wxThreadKind kind = wxTHREAD_DETACHED)

This constructor creates a new detached (default) or joinable C++ thread object. It does not create or start execution of the real thread -- for this you should use the Create and Run methods.

The possible values for kind parameters are:

wxTHREAD_DETACHED | Creates a detached thread.
wxTHREAD_JOINABLE | Creates a joinable thread.

### wxThread::~wxThread

~wxThread()

The destructor frees the resources associated with the thread. Notice that you should never delete a detached thread -- you may only call Delete on it or wait until it terminates (and auto destructs) itself. Because the detached threads delete themselves, they can only be allocated on the heap.

Joinable threads should be deleted explicitly. The Delete and Kill functions will not delete the C++ thread object. It is also safe to allocate them on stack.

### wxThread::Create

wxThreadError Create(unsigned int stackSize = 0)

Creates a new thread. The thread object is created in the suspended state, and you should call Run to start running it. You may optionally specify the stack size to be allocated to it (Ignored on platforms that don't support setting it explicitly, eg. Unix system without `pthread_attr_setstacksize`). If you do not specify the stack size, the system's default value is used.

Warning: It is a good idea to explicitly specify a value as systems' default values vary from just a couple of KB on some systems (BSD and OS/2 systems) to one or several MB (Windows, Solaris, Linux). So, if you have a thread that requires more than just a few KB of memory, you will have mysterious problems on some platforms but not on the common ones. On the other hand, just indicating a large stack size by default will give you performance issues on those systems with small default stack since those typically use fully committed memory for the stack. On the contrary, if use a lot of threads (say several hundred), virtual adress space can get tight unless you explicitly specify a smaller amount of thread stack space for each thread.

Return value

One of:

wxTHREAD_NO_ERROR | There was no error.
wxTHREAD_NO_RESOURCE | There were insufficient resources to create a new thread.
wxTHREAD_RUNNING | The thread is already running.

### wxThread::Delete

wxThreadError Delete()

Calling Delete gracefully terminates a detached thread, either when the thread calls TestDestroy or finished processing.

(Note that while this could work on a joinable thread you simply should not call this routine on one as afterwards you may not be able to call wxThread::Wait to free the memory of that thread).

See wxThread deletion for a broader explanation of this routine.

### wxThread::Entry

virtual ExitCode Entry()

This is the entry point of the thread. This function is pure virtual and must be implemented by any derived class. The thread execution will start here.

The returned value is the thread exit code which is only useful for joinable threads and is the value returned by Wait.

This function is called by wxWidgets itself and should never be called directly.

### wxThread::Exit

void Exit(ExitCode exitcode = 0)

This is a protected function of the wxThread class and thus can only be called from a derived class. It also can only be called in the context of this thread, i.e. a thread can only exit from itself, not from another thread.

This function will terminate the OS thread (i.e. stop the associated path of execution) and also delete the associated C++ object for detached threads. wxThread::OnExit will be called just before exiting.

### wxThread::GetCPUCount

static int GetCPUCount()

Returns the number of system CPUs or -1 if the value is unknown.

See also

SetConcurrency

### wxThread::GetCurrentId

static unsigned long GetCurrentId()

Returns the platform specific thread ID of the current thread as a long. This can be used to uniquely identify threads, even if they are not wxThreads.

### wxThread::GetId

unsigned long GetId() const

Gets the thread identifier: this is a platform dependent number that uniquely identifies the thread throughout the system during its existence (i.e. the thread identifiers may be reused).

### wxThread::GetPriority

int GetPriority() const

Gets the priority of the thread, between zero and 100.

The following priorities are defined:

WXTHREAD_MIN_PRIORITY | 0
WXTHREAD_DEFAULT_PRIORITY | 50
WXTHREAD_MAX_PRIORITY | 100

### wxThread::IsAlive

bool IsAlive() const

Returns `true` if the thread is alive (i.e. started and not terminating).

Note that this function can only safely be used with joinable threads, not detached ones as the latter delete themselves and so when the real thread is no longer alive, it is not possible to call this function because the wxThread object no longer exists.

### wxThread::IsDetached

bool IsDetached() const

Returns `true` if the thread is of the detached kind, `false` if it is a joinable one.

### wxThread::IsMain

static bool IsMain()

Returns `true` if the calling thread is the main application thread.

### wxThread::IsPaused

bool IsPaused() const

Returns `true` if the thread is paused.

### wxThread::IsRunning

bool IsRunning() const

Returns `true` if the thread is running.

This method may only be safely used for joinable threads, see the remark in IsAlive.

### wxThread::Kill

wxThreadError Kill()

Immediately terminates the target thread. This function is dangerous and should be used with extreme care (and not used at all whenever possible)! The resources allocated to the thread will not be freed and the state of the C runtime library may become inconsistent. Use Delete() for detached threads or Wait() for joinable threads instead.

For detached threads Kill() will also delete the associated C++ object. However this will not happen for joinable threads and this means that you will still have to delete the wxThread object yourself to avoid memory leaks. In neither case OnExit of the dying thread will be called, so no thread-specific cleanup will be performed.

This function can only be called from another thread context, i.e. a thread cannot kill itself.

It is also an error to call this function for a thread which is not running or paused (in the latter case, the thread will be resumed first) -- if you do it, a `wxTHREAD_NOT_RUNNING` error will be returned.

### wxThread::OnExit

void OnExit()

Called when the thread exits. This function is called in the context of the thread associated with the wxThread object, not in the context of the main thread. This function will not be called if the thread was killed.

This function should never be called directly.

### wxThread::Pause

wxThreadError Pause()

Suspends the thread. Under some implementations (Win32), the thread is suspended immediately, under others it will only be suspended when it calls TestDestroy for the next time (hence, if the thread doesn't call it at all, it won't be suspended).

This function can only be called from another thread context.

### wxThread::Run

wxThreadError Run()

Starts the thread execution. Should be called after Create.

This function can only be called from another thread context.

### wxThread::SetPriority

void SetPriority(int priority)

Sets the priority of the thread, between 0 and 100. It can only be set after calling Create() but before calling Run().

The following priorities are already defined:

WXTHREAD_MIN_PRIORITY | 0
WXTHREAD_DEFAULT_PRIORITY | 50
WXTHREAD_MAX_PRIORITY | 100

### wxThread::Sleep

static void Sleep(unsigned long milliseconds)

Pauses the thread execution for the given amount of time.

This function should be used instead of wxSleep by all worker threads (i.e. all except the main one).

### wxThread::Resume

wxThreadError Resume()

Resumes a thread suspended by the call to Pause.

This function can only be called from another thread context.

### wxThread::SetConcurrency

static bool SetConcurrency(size_t level)

Sets the thread concurrency level for this process. This is, roughly, the number of threads that the system tries to schedule to run in parallel. The value of 0 for level may be used to set the default one.

Returns `true` on success or false otherwise (for example, if this function is not implemented for this platform -- currently everything except Solaris).

### wxThread::TestDestroy

virtual bool TestDestroy()

This function should be called periodically by the thread to ensure that calls to Pause and Delete will work. If it returns `true`, the thread should exit as soon as possible.

Notice that under some platforms (POSIX), implementation of Pause also relies on this function being called, so not calling it would prevent both stopping and suspending thread from working.

### wxThread::This

static wxThread * This()

Return the thread object for the calling thread. NULL is returned if the calling thread is the main (GUI) thread, but IsMain should be used to test whether the thread is really the main one because NULL may also be returned for the thread not created with wxThread class. Generally speaking, the return value for such a thread is undefined.

### wxThread::Yield

void Yield()

Give the rest of the thread time slice to the system allowing the other threads to run. See also Sleep().

### wxThread::Wait

ExitCode Wait() const

Gracefully terminates a joinable thread, either when the thread calls TestDestroy or finished processing, and returns the value the thread returned from wxThread::Entry or `(ExitCode)-1` on error.

You can only Wait() for joinable (not detached) threads.

This function can only be called from another thread context.

See wxThread deletion for a broader explanation of this routine.