projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| dae2800a BP |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: funcmacro_thread.h | |
| 3 | // Purpose: Threads function and macro group docs | |
| 4 | // Author: wxWidgets team | |
| 5 | // RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ | |
| 526954c5 | 6 | // Licence: wxWindows licence |
| dae2800a BP |
7 | ///////////////////////////////////////////////////////////////////////////// |
| 8 | ||
| 9 | /** | |
| 10 | ||
| 11 | @defgroup group_funcmacro_thread Threads | |
| 12 | @ingroup group_funcmacro | |
| 13 | ||
| 3950d49c BP |
14 | The functions and macros here mainly exist to make it possible to write code |
| 15 | which may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in | |
| 16 | single thread configuration (wxUSE_THREADS = 0). | |
| dae2800a BP |
17 | |
| 18 | For example, a static variable must be protected against simultaneous access by | |
| 19 | multiple threads in the former configuration but in the latter the extra | |
| 20 | overhead of using the critical section is not needed. To solve this problem, | |
| 3950d49c BP |
21 | the wxCRITICAL_SECTION() macro may be used to create and use the critical |
| 22 | section only when needed. | |
| dae2800a BP |
23 | |
| 24 | @sa wxThread, wxMutex, @ref overview_thread | |
| 25 | ||
| dbbca9fd FM |
26 | Related class group: @ref group_class_threading |
| 27 | ||
| dae2800a BP |
28 | */ |
| 29 |