projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 6e6110ee VZ |
1 | \section{\class{wxCriticalSectionLocker}}\label{wxcriticalsectionlocker} |
| 2 | ||
| 3 | This is a small helper class to be used with \helpref{wxCriticalSection}{wxcriticalsection} | |
| 4 | objects. A wxCriticalSectionLocker enters the critical section in the | |
| 5 | constructor and leaves it in the destructor making it much more difficult to | |
| 6 | forget to leave a critical section (which, in general, will lead to serious | |
| 7 | and difficult to debug problems). | |
| 8 | ||
| 9 | \wxheading{Derived from} | |
| 10 | ||
| 11 | None. | |
| 12 | ||
| 954b8ae6 JS |
13 | \wxheading{Include files} |
| 14 | ||
| 15 | <wx/thread.h> | |
| 16 | ||
| 6e6110ee VZ |
17 | \wxheading{See also} |
| 18 | ||
| b82827dd | 19 | \helpref{wxCriticalSection}{wxcriticalsection}, |
| 6e6110ee VZ |
20 | \helpref{wxMutexLocker}{wxmutexlocker} |
| 21 | ||
| 22 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 23 | ||
| 24 | \membersection{wxCriticalSectionLocker::wxCriticalSectionLocker}\label{wxcriticalsectionlockerctor} | |
| b82827dd | 25 | |
| 6e6110ee VZ |
26 | \func{}{wxCriticalSectionLocker}{\param{wxCriticalSection *}{criticalsection}} |
| 27 | ||
| 28 | Constructs a wxCriticalSectionLocker object associated with given | |
| 29 | criticalsection which must be non NULL and enters it. | |
| 30 | ||
| 31 | \membersection{wxCriticalSectionLocker::\destruct{wxCriticalSectionLocker}}\label{wxcriticalsectionlockerdtor} | |
| b82827dd | 32 | |
| 6e6110ee VZ |
33 | \func{}{\destruct{wxCriticalSectionLocker}}{\void} |
| 34 | ||
| 35 | Destuctor leaves the criticalsection. | |
| b82827dd | 36 |