tarch::multicore::MultiReadSingleWriteLock Class Reference

Create a lock around a boolean semaphore region. More...

#include <MultiReadSingleWriteLock.h>

Collaboration diagram for tarch::multicore::MultiReadSingleWriteLock:

Public Member Functions
	MultiReadSingleWriteLock (tarch::multicore::MultiReadSingleWriteSemaphore &semaphore, bool isReadLock, bool aquireLockImmediately=true)
	Construct lock.
	~MultiReadSingleWriteLock ()
void	lock ()
void	free ()

Static Public Attributes
static constexpr bool	Read = true
static constexpr bool	Write = false

Private Attributes
MultiReadSingleWriteSemaphore &	_semaphore
const bool	_isReadLock
bool	_lockIsAquired

Detailed Description

Create a lock around a boolean semaphore region.

See also

tarch::multicore::BooleanSemaphore

Definition at line 19 of file MultiReadSingleWriteLock.h.

Constructor & Destructor Documentation

MultiReadSingleWriteLock()

tarch::multicore::MultiReadSingleWriteLock::MultiReadSingleWriteLock	(	tarch::multicore::MultiReadSingleWriteSemaphore &	semaphore,
		bool	isReadLock,
		bool	aquireLockImmediately = true )

Construct lock.

We have to know what semaphore to use and if it is a read or a write lock.

~MultiReadSingleWriteLock()

tarch::multicore::MultiReadSingleWriteLock::~MultiReadSingleWriteLock

(

)

Member Function Documentation

free()

void tarch::multicore::MultiReadSingleWriteLock::free

(

)

lock()

void tarch::multicore::MultiReadSingleWriteLock::lock

(

)

Field Documentation

_isReadLock

const bool tarch::multicore::MultiReadSingleWriteLock::_isReadLock

private

Definition at line 22 of file MultiReadSingleWriteLock.h.

_lockIsAquired

bool tarch::multicore::MultiReadSingleWriteLock::_lockIsAquired

private

Definition at line 23 of file MultiReadSingleWriteLock.h.

_semaphore

MultiReadSingleWriteSemaphore& tarch::multicore::MultiReadSingleWriteLock::_semaphore

private

Definition at line 21 of file MultiReadSingleWriteLock.h.

Read

constexpr bool tarch::multicore::MultiReadSingleWriteLock::Read = true

staticconstexpr

Definition at line 25 of file MultiReadSingleWriteLock.h.

Write

constexpr bool tarch::multicore::MultiReadSingleWriteLock::Write = false

staticconstexpr

Definition at line 26 of file MultiReadSingleWriteLock.h.

---

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

• src/tarch/multicore/MultiReadSingleWriteLock.h