X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f06afb9ceb2c233083dda4d7dcbe49b2dadf0a7b..24d705907ddcbe8e701867be2fb6f457a3dfab6f:/docs/latex/wx/thread.tex?ds=inline diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex index 558d3cc709..cd4a11cb24 100644 --- a/docs/latex/wx/thread.tex +++ b/docs/latex/wx/thread.tex @@ -8,7 +8,7 @@ much easier to share common data between several threads, it also makes much easier to shoot oneself in the foot, so careful use of synchronization objects such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcriticalsection} is recommended. -There are two types of threads in wxWindows: {\it detached} and {\it joinable} +There are two types of threads in wxWidgets: {\it detached} and {\it joinable} ones, just as in the POSIX thread API (but unlike Win32 threads where all threads are joinable). The difference between the two is that only joinable threads can return a return code -- this is returned by the Wait() function. Detached @@ -102,7 +102,7 @@ One of: Calling \helpref{Delete}{wxthreaddelete} is a graceful way to terminate the thread. It asks the thread to terminate and, if the thread code is well -written, the thread will terminate after the next call to +written, the thread will terminate after the next call to \helpref{TestDestroy}{wxthreadtestdestroy} which should happen quite soon. However, if the thread doesn't call \helpref{TestDestroy}{wxthreadtestdestroy} @@ -134,7 +134,7 @@ 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 \helpref{Wait}{wxthreadwait}. -This function is called by wxWindows itself and should never be called +This function is called by wxWidgets itself and should never be called directly. @@ -341,17 +341,21 @@ 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 {\it level} may be used to set the default one. -Returns true on success or false otherwise (for example, if this function is +Returns \true on success or false otherwise (for example, if this function is not implemented for this platform -- currently everything except Solaris). \membersection{wxThread::TestDestroy}\label{wxthreadtestdestroy} -\func{bool}{TestDestroy}{\void} +\func{virtual bool}{TestDestroy}{\void} This function should be called periodically by the thread to ensure that calls to \helpref{Pause}{wxthreadpause} and \helpref{Delete}{wxthreaddelete} will -work. If it returns true, the thread should exit as soon as possible. +work. If it returns \true, the thread should exit as soon as possible. + +Notice that under some platforms (POSIX), implementation of +\helpref{Pause}{wxthreadpause} also relies on this function being called, so +not calling it would prevent both stopping and suspending thread from working. \membersection{wxThread::This}\label{wxthreadthis}