class VMutex

Defines a simple mutex class which provides 'fast' mutex functionality, meaning that if the calling thread already has the mutex locked, a call to lock will block the thread forever

Public Fields

mutable vmutex_t myId
prevent copy constructor -- this will be done in the future, but currently cannot be done due to SipThread having a copy constructor & assignment operator

Public Methods

vmutex_t* getId()
Returns the operating system dependent unique id of the mutex
void lock()
Lock the mutex
void unlock()
Unlock the mutex
VMutex()
Create a VMutex object initialized with operating system dependent defaults (if any)
~VMutex()
Delete a VMutex object

Private

prevent assignment -- this will be done in the future, but currently cannot be done due to SipThread having a copy constructor & assignment operator

Documentation

Defines a simple mutex class which provides 'fast' mutex functionality, meaning that if the calling thread already has the mutex locked, a call to lock will block the thread forever
VMutex()
Create a VMutex object initialized with operating system dependent defaults (if any)

~VMutex()
Delete a VMutex object

void lock()
Lock the mutex. If the mutex is currently unlocked, it becomes locked and owned by the calling thread, and lock returns immediately. If the mutex is already locked by another thread, lock suspends the calling thread until the mutex is unlocked. If the mutex is already locked by the calling thread, the calling thread blocks forever.

void unlock()
Unlock the mutex. The mutex is assumed to be locked and owned by the calling thread, meaning that a call to unlock always returns it to the unlocked state.

vmutex_t* getId()
Returns the operating system dependent unique id of the mutex

prevent assignment -- this will be done in the future, but currently cannot be done due to SipThread having a copy constructor & assignment operator

mutable vmutex_t myId
prevent copy constructor -- this will be done in the future, but currently cannot be done due to SipThread having a copy constructor & assignment operator


This class has no child classes.

alphabetic index hierarchy of classes


generated by doc++