This mutex class defines the interface for a mutex that has "recursive" semantics. More...

Detailed Description

This mutex class defines the interface for a mutex that has "recursive" semantics.

Recursive semantic allows the thread that owns the mutex to acquire ownership multiple times by calling lock() multiple times. There must be a corresponding number of unlock() calls made before the ownership of the mutex is released.

#include <Mutex.h>

Classes
class	ScopeBlock
	This concrete class provides a simple mechanism for providing mutex protection for a "scope block". More...

Public Member Functions
	Mutex ()
	Constructor.

	~Mutex ()
	Destructor.

void	lock (void)
	This method is invoked prior to entering a critical section.

void	unlock (void)
	This method is invoke at the end of a critical section.

Protected Attributes
Cpl_System_Mutex_T	m_mutex
	Raw Mutex handle/instance/pointer.

Constructor & Destructor Documentation

◆ Mutex()

Cpl::System::Mutex::Mutex ( )

Constructor.

◆ ~Mutex()

Cpl::System::Mutex::~Mutex ( )

Destructor.

Member Function Documentation

◆ lock()

void Cpl::System::Mutex::lock ( void )

This method is invoked prior to entering a critical section.

If another thread currently "owns" the mutex, the current thread will "wait" until it can obtain ownership before proceeding.

◆ unlock()

void Cpl::System::Mutex::unlock ( void )

This method is invoke at the end of a critical section.

This call will release the ownership of the mutex.

Member Data Documentation

◆ m_mutex

Cpl_System_Mutex_T Cpl::System::Mutex::m_mutex

protected

Raw Mutex handle/instance/pointer.

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

Cpl/System/Mutex.h