2008-03-14 01:47:17 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: funcmacro_thread.h
|
|
|
|
// Purpose: Threads function and macro group docs
|
|
|
|
// Author: wxWidgets team
|
2010-07-13 09:29:13 -04:00
|
|
|
// Licence: wxWindows licence
|
2008-03-14 01:47:17 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
@defgroup group_funcmacro_thread Threads
|
|
|
|
@ingroup group_funcmacro
|
|
|
|
|
2008-03-25 03:36:12 -04:00
|
|
|
The functions and macros here mainly exist to make it possible to write code
|
|
|
|
which may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in
|
|
|
|
single thread configuration (wxUSE_THREADS = 0).
|
2008-03-14 01:47:17 -04:00
|
|
|
|
|
|
|
For example, a static variable must be protected against simultaneous access by
|
|
|
|
multiple threads in the former configuration but in the latter the extra
|
|
|
|
overhead of using the critical section is not needed. To solve this problem,
|
2008-03-25 03:36:12 -04:00
|
|
|
the wxCRITICAL_SECTION() macro may be used to create and use the critical
|
|
|
|
section only when needed.
|
2008-03-14 01:47:17 -04:00
|
|
|
|
|
|
|
@sa wxThread, wxMutex, @ref overview_thread
|
|
|
|
|
2008-12-12 13:51:54 -05:00
|
|
|
Related class group: @ref group_class_threading
|
|
|
|
|
2008-03-14 01:47:17 -04:00
|
|
|
*/
|
|
|
|
|