Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
fawkes::LockMap< KeyType, ValueType, LessKey > Class Template Reference

Map with a lock. More...

#include <>>

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

List of all members.

Public Member Functions

 LockMap ()
 Constructor.
 LockMap (const LockMap< KeyType, ValueType, LessKey > &lm)
 Copy constructor.
virtual ~LockMap ()
 Destructor.
void lock () const
 Lock list.
bool try_lock () const
 Try to lock list.
void unlock () const
 Unlock list.
RefPtr< Mutexmutex () const
 Get access to the internal mutex.
void erase_locked (const KeyType &key)
 Remove item with lock.
LockMap< KeyType, ValueType,
LessKey > & 
operator= (const LockMap< KeyType, ValueType, LessKey > &ll)
 Copy values from another LockMap.
LockMap< 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::map< K, T >
keys
 STL member.
elements
 STL member.

Detailed Description

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

Map with a lock.

This class provides a map 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_map.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 76 of file lock_map.h.

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

Copy constructor.

Parameters:
lmLockMap to copy

Definition at line 85 of file lock_map.h.

template<typename KeyType , typename ValueType , typename LessKey >
fawkes::LockMap< KeyType, ValueType, LessKey >::~LockMap ( )
virtual

Destructor.

Definition at line 93 of file lock_map.h.


Member Function Documentation

template<typename KeyType, typename ValueType , typename LessKey >
void fawkes::LockMap< 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_map.h.

Referenced by fawkes::BlackBoardNetworkHandler::client_disconnected(), fawkes::PluginManager::load(), and fawkes::PluginManager::unload().

template<typename KeyType , typename ValueType , typename LessKey >
RefPtr< Mutex > fawkes::LockMap< 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_map.h.

Referenced by FvBaseThread::acquire_camctrl(), and fawkes::PluginManager::load().

template<typename KeyType, typename ValueType, typename LessKey>
LockMap< KeyType, ValueType, LessKey > & fawkes::LockMap< KeyType, ValueType, LessKey >::operator= ( const LockMap< KeyType, ValueType, LessKey > &  ll)

Copy values from another LockMap.

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_map.h.

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

template<typename KeyType, typename ValueType, typename LessKey>
LockMap< KeyType, ValueType, LessKey > & fawkes::LockMap< 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_map.h.

template<typename KeyType , typename ValueType , typename LessKey >
bool fawkes::LockMap< 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_map.h.


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