wxWidgets: wxMutexLocker Class Reference

| Version: 3.0.4

Public Member Functions | List of all members
wxMutexLocker Class Reference
Class List by Category » Threading

`#include </usr/src/ports/wxWidgets3.0/wxWidgets3.0-3.0.4-1.i686/src/wxWidgets-3.0.4/interface/wx/thread.h>`

## Detailed Description

This is a small helper class to be used with 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 wxMutex for an example of wxMutexLocker usage.

##

Library: wxBase

<>< =''>:</>&;&;< =''>\ </></>

See also
  wxMutex, wxCriticalSectionLocker

## Public Member Functions
| wxMutexLocker (wxMutex &mutex)
| Constructs a wxMutexLocker object associated with mutex and locks it. More...
| ~wxMutexLocker ()
| Destructor releases the mutex if it was successfully acquired in the ctor. More...
bool | IsOk () const
| Returns true if mutex was acquired in the constructor, false otherwise. More...

## Constructor & Destructor Documentation

## ◆ wxMutexLocker()

wxMutexLocker::wxMutexLocker | ( | wxMutex & | mutex | ) |

Constructs a wxMutexLocker object associated with mutex and locks it.

Call IsOk() to check if the mutex was successfully locked.

## ◆ ~wxMutexLocker()

wxMutexLocker::~wxMutexLocker | ( |  | ) |

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

## Member Function Documentation

## ◆ IsOk()

bool wxMutexLocker::IsOk | ( |  | ) | const

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