Fawkes API  Fawkes Development Version
fawkes::LockMultiMap< KeyType, ValueType, LessKey > Class Template Reference

Multi-Map with a lock. More...

#include <>>

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

Public Member Functions

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

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

◆ LockMultiMap() [1/2]

template<typename KeyType , typename ValueType , typename LessKey >
fawkes::LockMultiMap< KeyType, ValueType, LessKey >::LockMultiMap ( )

Constructor.

Definition at line 76 of file lock_multimap.h.

◆ LockMultiMap() [2/2]

template<typename KeyType, typename ValueType, typename LessKey>
fawkes::LockMultiMap< KeyType, ValueType, LessKey >::LockMultiMap ( const LockMultiMap< KeyType, ValueType, LessKey > &  lm)

Copy constructor.

Parameters
lmLockMultiMap to copy

Definition at line 85 of file lock_multimap.h.

◆ ~LockMultiMap()

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

◆ erase_locked()

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
keykey of the value to erase

Definition at line 132 of file lock_multimap.h.

◆ lock()

template<typename KeyType , typename ValueType , typename LessKey >
void fawkes::LockMultiMap< KeyType, ValueType, LessKey >::lock ( ) const

◆ mutex()

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.

◆ operator=() [1/2]

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
llmap to copy
Returns
reference to this instance

Definition at line 161 of file lock_multimap.h.

◆ operator=() [2/2]

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
lmap to copy
Returns
reference to this instance

Definition at line 185 of file lock_multimap.h.

◆ try_lock()

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.

Referenced by fawkes::LockMultiMap< fawkes::LedInterface *, std::string >::try_lock().

◆ unlock()

template<typename KeyType , typename ValueType , typename LessKey >
void fawkes::LockMultiMap< KeyType, ValueType, LessKey >::unlock ( ) const

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