fawkes::LockMultiMap< KeyType, ValueType, LessKey > Class Template Reference

Multi-Map with a lock. More...

#include <>>

Inheritance diagram for fawkes::LockMultiMap< KeyType, ValueType, LessKey >:

List of all members.

Public Member Functions
	LockMultiMap ()
	Constructor.
	LockMultiMap (const LockMultiMap< KeyType, ValueType, LessKey > &lm)
	Copy constructor.
virtual	~LockMultiMap ()
	Destructor.
void	lock () const
	Lock list.
bool	try_lock () const
	Try to lock list.
void	unlock () const
	Unlock list.
RefPtr< Mutex >	mutex () const
	Get access to the internal mutex.
void	erase_locked (const KeyType &key)
	Remove item with lock.
LockMultiMap< KeyType, ValueType, LessKey > &	operator= (const LockMultiMap< KeyType, ValueType, LessKey > &ll)
	Copy values from another LockMultiMap.
LockMultiMap< KeyType, ValueType, LessKey > &	operator= (const std::map< KeyType, ValueType, LessKey > &l)
	Copy values from a standard map.

Additional Inherited Members
Public Attributes inherited from std::multimap< K, T >
K	keys
	STL member.
T	elements
	STL member.

---

Detailed Description

template<typename KeyType, typename ValueType, typename LessKey = std::less<KeyType>>
class fawkes::LockMultiMap< KeyType, ValueType, LessKey >

Multi-Map with a lock.

This class provides a multimap that has an intrinsic lock. The lock can be applied with the regular locking methods.

See also:

Mutex

Author:

Tim Niemueller

Definition at line 37 of file lock_multimap.h.

---

Constructor & Destructor Documentation

template<typename KeyType , typename ValueType , typename LessKey >

fawkes::LockMultiMap< KeyType, ValueType, LessKey >::LockMultiMap

(

)

Constructor.

Definition at line 76 of file lock_multimap.h.

template<typename KeyType, typename ValueType, typename LessKey>

fawkes::LockMultiMap< KeyType, ValueType, LessKey >::LockMultiMap

(

const LockMultiMap< KeyType, ValueType, LessKey > &

lm

)

Copy constructor.

Parameters:

lm	LockMultiMap to copy

Definition at line 85 of file lock_multimap.h.

template<typename KeyType , typename ValueType , typename LessKey >

fawkes::LockMultiMap< KeyType, ValueType, LessKey >::~LockMultiMap ( )

virtual

Destructor.

Definition at line 93 of file lock_multimap.h.

---

Member Function Documentation

template<typename KeyType, typename ValueType , typename LessKey >

void fawkes::LockMultiMap< KeyType, ValueType, LessKey >::erase_locked

(

const KeyType &

key

)

Remove item with lock.

The map is automatically locked and unlocked during the removal.

Parameters:

key	key of the value to erase

Definition at line 132 of file lock_multimap.h.

template<typename KeyType , typename ValueType , typename LessKey >

void fawkes::LockMultiMap< KeyType, ValueType, LessKey >::lock

(

)

const

Lock list.

Definition at line 100 of file lock_multimap.h.

Referenced by fawkes::LockMultiMap< KeyType, ValueType, LessKey >::operator=().

template<typename KeyType , typename ValueType , typename LessKey >

RefPtr< Mutex > fawkes::LockMultiMap< KeyType, ValueType, LessKey >::mutex

(

)

const

Get access to the internal mutex.

Can be used with MutexLocker.

Returns:

internal mutex

Definition at line 146 of file lock_multimap.h.

template<typename KeyType, typename ValueType, typename LessKey>

LockMultiMap< KeyType, ValueType, LessKey > & fawkes::LockMultiMap< KeyType, ValueType, LessKey >::operator=

(

const LockMultiMap< KeyType, ValueType, LessKey > &

ll

)

Copy values from another LockMultiMap.

Copies the values one by one. Both instances are locked during the copying and this instance is cleared before copying.

Parameters:

ll	map to copy

Returns:

reference to this instance

Definition at line 161 of file lock_multimap.h.

References fawkes::LockMultiMap< KeyType, ValueType, LessKey >::lock(), and fawkes::LockMultiMap< KeyType, ValueType, LessKey >::unlock().

template<typename KeyType, typename ValueType, typename LessKey>

LockMultiMap< KeyType, ValueType, LessKey > & fawkes::LockMultiMap< KeyType, ValueType, LessKey >::operator=

(

const std::map< KeyType, ValueType, LessKey > &

l

)

Copy values from a standard map.

Copies the values one by one. This instance is locked during the copying and cleared.

Parameters:

l	map to copy

Returns:

reference to this instance

Definition at line 185 of file lock_multimap.h.

template<typename KeyType , typename ValueType , typename LessKey >

bool fawkes::LockMultiMap< KeyType, ValueType, LessKey >::try_lock

(

)

const

Try to lock list.

Returns:

true, if the lock has been aquired, false otherwise.

Definition at line 111 of file lock_multimap.h.

template<typename KeyType , typename ValueType , typename LessKey >

void fawkes::LockMultiMap< KeyType, ValueType, LessKey >::unlock

(

)

const

Unlock list.

Definition at line 120 of file lock_multimap.h.

Referenced by fawkes::LockMultiMap< KeyType, ValueType, LessKey >::operator=().

---

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

• src/libs/core/utils/lock_multimap.h