latex/wx/thread.tex

1 \section{\class{wxThread}}\label{wxthread}
36 processing or through a call to \helpref{wxThread::Delete}{wxthreaddelete}, and thus
40 for one to get value it returned from \helpref{wxThread::Entry}{wxthreadentry}
41 through \helpref{wxThread::Wait}{wxthreadwait}.
46 corresponding wxThread object yourself if you did not create it on the stack. In
50 \membersection{wxThread deletion}\label{deletionwxthread}
53 \helpref{wxThread::Wait}{wxthreadwait} on a joinable thread to release its
62 \helpref{wxThread::Delete}{wxthreaddelete} to gracefully end it (which implies
67 As mentioned, \helpref{wxThread::Wait}{wxthreadwait} or
68 \helpref{wxThread::Delete}{wxthreaddelete} attempts to gracefully terminate
70 the thread in question calls \helpref{wxThread::TestDestroy}{wxthreadtestdestroy}
71 or ends processing (returns from \helpref{wxThread::Entry}{wxthreadentry}).
78 \helpref{wxThread::Kill}{wxthreadkill}. It is strongly recommended that you
80 the object (although the wxThread object of detached threads will still be
88 by \helpref{wxThread::Create}{wxthreadcreate} or the corresponding constructors.
93 including the underlying native API and the fact that wxThread does not run a
104 \membersection{Don't poll a wxThread}\label{dontpollwxthread}
106 A common problem users experience with wxThread is that in their main thread
108 \helpref{wxThread::IsRunning}{wxthreadisrunning}, only to find that their
113 However, polling a wxThread for when it has ended is in general a bad idea -
114 in fact calling a routine on any running wxThread should be avoided if
124 \membersection{wxThread::wxThread}\label{wxthreadctor}
126 \func{}{wxThread}{\param{wxThreadKind }{kind = wxTHREAD\_DETACHED}}
141 \membersection{wxThread::\destruct{wxThread}}\label{wxthreaddtor}
143 \func{}{\destruct{wxThread}}{\void}
156 \membersection{wxThread::Create}\label{wxthreadcreate}
192 \membersection{wxThread::Delete}\label{wxthreaddelete}
201 \helpref{wxThread::Wait}{wxthreadwait} to free the memory of that thread).
203 See \helpref{wxThread deletion}{deletionwxthread} for a broader explanation of this routine.
207 \membersection{wxThread::Entry}\label{wxthreadentry}
221 \membersection{wxThread::Exit}\label{wxthreadexit}
225 This is a protected function of the wxThread class and thus can only be called
231 \helpref{wxThread::OnExit}{wxthreadonexit} will be called just before exiting.
234 \membersection{wxThread::GetCPUCount}\label{wxthreadgetcpucount}
245 \membersection{wxThread::GetCurrentId}\label{wxthreadgetcurrentid}
254 \membersection{wxThread::GetId}\label{wxthreadgetid}
262 \membersection{wxThread::GetPriority}\label{wxthreadgetpriority}
278 \membersection{wxThread::IsAlive}\label{wxthreadisalive}
287 the wxThread object no longer exists.
289 \membersection{wxThread::IsDetached}\label{wxthreadisdetached}
297 \membersection{wxThread::IsMain}\label{wxthreadismain}
304 \membersection{wxThread::IsPaused}\label{wxthreadispaused}
311 \membersection{wxThread::IsRunning}\label{wxthreadisrunning}
321 \membersection{wxThread::Kill}\label{wxthreadkill}
333 still have to delete the wxThread object yourself to avoid memory leaks.
345 \membersection{wxThread::OnExit}\label{wxthreadonexit}
350 thread associated with the wxThread object, not in the context of the main
357 \membersection{wxThread::Pause}\label{wxthreadpause}
369 \membersection{wxThread::Run}\label{wxthreadrun}
379 \membersection{wxThread::SetPriority}\label{wxthreadsetpriority}
397 \membersection{wxThread::Sleep}\label{wxthreadsleep}
407 \membersection{wxThread::Resume}\label{wxthreadresume}
416 \membersection{wxThread::SetConcurrency}\label{wxthreadsetconcurrency}
428 \membersection{wxThread::TestDestroy}\label{wxthreadtestdestroy}
441 \membersection{wxThread::This}\label{wxthreadthis}
443 \func{static wxThread *}{This}{\void}
448 not created with wxThread class. Generally speaking, the return value for such a thread
452 \membersection{wxThread::Yield}\label{wxthreadyield}
460 \membersection{wxThread::Wait}\label{wxthreadwait}
465 returned from \helpref{wxThread::Entry}{wxthreadentry} or {\tt (ExitCode)-1} on
474 See \helpref{wxThread deletion}{deletionwxthread} for a broader explanation of this routine.