]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/tthreads.tex
Bug 1099143 and more occurences of the same set vs. get mistakes.
[wxWidgets.git] / docs / latex / wx / tthreads.tex
... / ...
CommitLineData
1\section{Multithreading overview}\label{wxthreadoverview}
2
3Classes: \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex},
4\helpref{wxCriticalSection}{wxcriticalsection},
5\helpref{wxCondition}{wxcondition}
6
7wxWidgets provides a complete set of classes encapsulating objects necessary in
8multithreaded (MT) programs: the \helpref{thread}{wxthread} class itself and different
9synchronization objects: \helpref{mutexes}{wxmutex} and
10\helpref{critical sections}{wxcriticalsection} with
11\helpref{conditions}{wxcondition}. The thread API in wxWidgets resembles to
12POSIX1.c threads API (a.k.a. pthreads), although several functions have
13different names and some features inspired by Win32 thread API are there as
14well.
15
16These classes will hopefully make writing MT programs easier and they also
17provide some extra error checking (compared to the native (be it Win32 or Posix)
18thread API), however it is still an non-trivial undertaking especially for large
19projects. Before starting an MT application (or starting to add MT features to
20an existing one) it is worth asking oneself if there is no easier and safer way
21to implement the same functionality. Of course, in some situations threads
22really make sense (classical example is a server application which launches a
23new thread for each new client), but in others it might be a very poor choice
24(example: launching a separate thread when doing a long computation to show a
25progress dialog). Other implementation choices are available: for the progress
26dialog example it is far better to do the calculations in the
27\helpref{idle handler}{wxidleevent} or even simply do everything at once
28but call \helpref{wxWindow::Update()}{wxwindowupdate} periodically to update
29the screen.
30
31If you do decide to use threads in your application, it is strongly recommended
32that no more than one thread calls GUI functions. The thread sample shows that
33it {\it is} possible for many different threads to call GUI functions at once
34(all the threads created in the sample access GUI), but it is a very poor design
35choice for anything except an example. The design which uses one GUI thread and
36several worker threads which communicate with the main one using events is much
37more robust and will undoubtedly save you countless problems (example: under
38Win32 a thread can only access GDI objects such as pens, brushes, \&c created by
39itself and not by the other threads).
40
41For communication between secondary threads and the main thread, you may use
42\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}
43or its short version \helpref{wxPostEvent}{wxpostevent}. These functions
44have thread safe implementation so that they can be used as they are for
45sending events from one thread to another. However there is no built in method
46to send messages to the worker threads and you will need to use the available
47synchronization classes to implement the solution which suits your needs
48yourself. In particular, please note that it is \emph{not} enough to derive
49your class from \helpref{wxThread}{wxthread} and
50\helpref{wxEvtHandler}{wxevthandler} to send messages to it: in fact, this does
51\emph{not} work at all.
52
53