CascadeMutex Class Reference

an easy to use mutex More...

#include <cascade/interthread/CascadeMutex.h>

Inheritance diagram for CascadeMutex:

List of all members.

Public Member Functions
	CascadeMutex ()
virtual	~CascadeMutex ()
void	Lock ()
bool	TryLock ()
	TryLock(), Unlock().
void	Unlock ()

---

Detailed Description

an easy to use mutex

Skip the description

CascadeMutex provides a lightweight mutex that provides thread locking and is easy to use.

---

class CascadeMutex

---

Constructor & Destructor Documentation

CascadeMutex::CascadeMutex (   )

the default constructor - lightweight This default constructor is lightweight.

virtual CascadeMutex::~CascadeMutex (   )  [virtual]

destructor The destructor.

---

Member Function Documentation

void CascadeMutex::Lock (   )

locks the mutex

bool CascadeMutex::TryLock (   )

TryLock(), Unlock(). tries to lock the mutex TryLock() tries to lock the mutex, doing so and returning true if the mutex was locked. TryLock() never blocks - if the mutex is currently locked by another thread TryLock() returns false without blocking and without locking the mutex. Returns: true if the mutex was locked successfully, false otherwise See also: Lock(), Unlock()

void CascadeMutex::Unlock (   )

unlocks the mutex Call Unlock() to unlock the mutex. Be sure to call Unlock() for each call to Lock() (or successful TryLock()). See also: Lock(), TryLock()

---

The documentation for this class was generated from the following file:

• CascadeMutex.h

---