This class is the implementation of the read/write lock. More...

#include <GenericRWLockImpl.hpp>

Classes
struct	LockerInfo

Public Member Functions
	GenericRWLockImpl ()

	~GenericRWLockImpl ()

void	acquireReadLock (const IdT id, const Timeout &timeout)

void	acquireWriteLock (const IdT id, const Timeout &timeout)

void	releaseReadLock (const IdT id)

void	releaseWriteLock (const IdT id)

Private Types
typedef std::map< IdT, LockerInfo, CompareT >	IdMap

Private Member Functions
	GenericRWLockImpl (const GenericRWLockImpl &)

GenericRWLockImpl &	operator= (const GenericRWLockImpl &)

Private Attributes
Condition	m_waiting_writers

bool	m_canRead

Condition	m_waiting_readers

NonRecursiveMutex	m_guard

unsigned	m_numReaders

unsigned	m_numWriters

IdMap	m_lockerInfo

Detailed Description

template<typename IdT, typename CompareT>
class BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >

This class is the implementation of the read/write lock.

It isn't thread specific and thus may be used for other types of locking, such as for transactions which may span threads, in which case the transaction would be the id. The read/write lock is recursive and also supports upgrading a read-lock to a write lock.

Definition at line 64 of file GenericRWLockImpl.hpp.

Member Typedef Documentation

◆ IdMap

template<typename IdT , typename CompareT >

typedef std::map<IdT, LockerInfo, CompareT> BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::IdMap

private

Definition at line 120 of file GenericRWLockImpl.hpp.

Constructor & Destructor Documentation

◆ GenericRWLockImpl() [1/2]

template<typename IdT , typename CompareT >

BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::GenericRWLockImpl ( )

Definition at line 130 of file GenericRWLockImpl.hpp.

◆ ~GenericRWLockImpl()

template<typename IdT , typename CompareT >

BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::~GenericRWLockImpl ( )

Definition at line 138 of file GenericRWLockImpl.hpp.

◆ GenericRWLockImpl() [2/2]

template<typename IdT , typename CompareT >

BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::GenericRWLockImpl ( const GenericRWLockImpl< IdT, CompareT > & )

private

Member Function Documentation

◆ acquireReadLock()

template<typename IdT , typename CompareT >

void BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::acquireReadLock	(	const IdT	id,
		const Timeout &	timeout )

Exceptions

TimeoutException if the lock isn't acquired within the timeout.

Definition at line 144 of file GenericRWLockImpl.hpp.

References BLOCXX_ASSERT, BLOCXX_THROW, m_guard, BLOCXX_NAMESPACE::operator==(), and BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::LockerInfo::readCount.

◆ acquireWriteLock()

template<typename IdT , typename CompareT >

void BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::acquireWriteLock	(	const IdT	id,
		const Timeout &	timeout )

Exceptions

TimeoutException	if the lock isn't acquired within the timeout.
DeadlockException	if this call would upgrade a read lock to a write lock and another id is already waiting to upgrade. If this happens, the calling thread must release it's read lock in order for forward progress to be made.

Definition at line 211 of file GenericRWLockImpl.hpp.

References BLOCXX_ASSERT, BLOCXX_THROW, m_guard, BLOCXX_NAMESPACE::operator==(), and BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::LockerInfo::readCount.