tarch::mpi::Lock Class Reference

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

#include <Lock.h>

Collaboration diagram for tarch::mpi::Lock:

Public Member Functions
	Lock (tarch::mpi::BooleanSemaphore &semaphore, bool aquireLockImmediately=true)
	~Lock ()
void	lock ()
void	free ()

Private Attributes
BooleanSemaphore &	_semaphore
bool	_lockIsAquired

Detailed Description

Create a lock around a boolean semaphore region.

See also

tarch::mpi::BooleanSemaphore

Definition at line 20 of file Lock.h.

Constructor & Destructor Documentation

Lock()

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

Definition at line 6 of file Lock.cpp.

References _lockIsAquired, _semaphore, and lock().

Here is the call graph for this function:

~Lock()

tarch::mpi::Lock::~Lock

(

)

Definition at line 15 of file Lock.cpp.

References _lockIsAquired, and free().

Here is the call graph for this function:

Member Function Documentation

free()

void tarch::mpi::Lock::free

(

)

Definition at line 29 of file Lock.cpp.

References _lockIsAquired, _semaphore, and assertion.

Referenced by ~Lock().

Here is the caller graph for this function:

lock()

void tarch::mpi::Lock::lock

(

)

Definition at line 22 of file Lock.cpp.

References _lockIsAquired, _semaphore, and assertion.

Referenced by Lock().

Here is the caller graph for this function:

Field Documentation

_lockIsAquired

bool tarch::mpi::Lock::_lockIsAquired

private

Definition at line 23 of file Lock.h.

Referenced by free(), Lock(), lock(), and ~Lock().

_semaphore

BooleanSemaphore& tarch::mpi::Lock::_semaphore

private

Definition at line 22 of file Lock.h.

Referenced by free(), Lock(), and lock().

---

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

• src/tarch/mpi/Lock.h
• src/tarch/mpi/Lock.cpp