tarch::multicore::Lock Class Reference

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

#include <Lock.h>

Collaboration diagram for tarch::multicore::Lock:

Public Member Functions
	Lock (tarch::multicore::BooleanSemaphore &semaphore, bool aquireLockImmediately=true, bool freeLockInDestructor=true)
	Create lock around semaphore.
	~Lock ()
void	lock ()
void	free ()
	Free the lock.
bool	tryLock ()

Private Attributes
BooleanSemaphore &	_semaphore
bool	_lockIsAquired
const bool	_freeLockInDestructor

Detailed Description

Create a lock around a boolean semaphore region.

See also

tarch::multicore::BooleanSemaphore

Definition at line 19 of file Lock.h.

Constructor & Destructor Documentation

Lock()

tarch::multicore::Lock::Lock	(	tarch::multicore::BooleanSemaphore &	semaphore,
		bool	aquireLockImmediately = true,
		bool	freeLockInDestructor = true )

Create lock around semaphore.

Parameters

aquireLockImmediately	If set, the constructor locks the semaphore immediately when you construct the object. If the parameter is overwritten with false, you have to use the lock's lock() operation.
freeLockInDestructor	If set and if the lock has locked the semaphore, it will free it in the destructor unless you have manually unlocked it before. This parameter should be altered very carefully.

~Lock()

tarch::multicore::Lock::~Lock

(

)

Member Function Documentation

free()

void tarch::multicore::Lock::free

(

)

Free the lock.

There is an assertion here that checks if you have acquired the lock before. When people use the locks to wrap around the semaphore and to alter it manually, i.e. when they disable the automatic lock management in the constructor by unsetting freeLockInDestructor, then these checks are not valid anymore.

lock()

void tarch::multicore::Lock::lock

(

)

tryLock()

bool tarch::multicore::Lock::tryLock

(

)

Field Documentation

_freeLockInDestructor

const bool tarch::multicore::Lock::_freeLockInDestructor

private

Definition at line 23 of file Lock.h.

_lockIsAquired

bool tarch::multicore::Lock::_lockIsAquired

private

Definition at line 22 of file Lock.h.

_semaphore

BooleanSemaphore& tarch::multicore::Lock::_semaphore

private

Definition at line 21 of file Lock.h.

---

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

• src/tarch/multicore/Lock.h