File: mutexlck.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (43 lines) | stat: -rw-r--r-- 1,315 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
\section{\class{wxMutexLocker}}\label{wxmutexlocker}

This is a small helper class to be used with \helpref{wxMutex}{wxmutex} 
objects. A wxMutexLocker acquires a mutex lock in the constructor and releases
(or unlocks) the mutex in the destructor making it much more difficult to
forget to release a mutex (which, in general, will promptly lead to serious
problems). See \helpref{wxMutex}{wxmutex} for an example of wxMutexLocker
usage.

\wxheading{Derived from}

None.

\wxheading{Include files}

<wx/thread.h>

\wxheading{See also}

\helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}

\func{}{wxMutexLocker}{\param{wxMutex\&}{ mutex}}

Constructs a wxMutexLocker object associated with mutex and locks it.
Call \helpref{IsOk}{wxmutexlockerisok} to check if the mutex was
successfully locked.

\membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}

\func{}{\destruct{wxMutexLocker}}{\void}

Destructor releases the mutex if it was successfully acquired in the ctor.

\membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}

\constfunc{bool}{IsOk}{\void}

Returns true if mutex was acquired in the constructor, false otherwise.