Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
fawkes::LockList< Type > Class Template Reference

List with a lock. More...

#include <>>

Inheritance diagram for fawkes::LockList< Type >:

List of all members.

Public Member Functions

 LockList ()
 Constructor.
 LockList (const LockList< Type > &ll)
 Copy constructor.
virtual ~LockList ()
 Destructor.
virtual void lock () const
 Lock list.
virtual bool try_lock () const
 Try to lock list.
virtual void unlock () const
 Unlock list.
RefPtr< Mutexmutex () const
 Get access to the internal mutex.
void push_back_locked (const Type &x)
 Push element to list at back with lock protection.
void push_front_locked (const Type &x)
 Push element to list at front with lock protection.
void remove_locked (const Type &x)
 Remove element from list with lock protection.
LockList< Type > & operator= (const LockList< Type > &ll)
 Copy values from another LockList.
LockList< Type > & operator= (const std::list< Type > &l)
 Copy values from a standard list.

Additional Inherited Members

- Public Attributes inherited from std::list< T >
elements
 STL member.

Detailed Description

template<typename Type>
class fawkes::LockList< Type >

List with a lock.

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

See also:
Mutex
Author:
Tim Niemueller

Definition at line 44 of file lock_list.h.


Constructor & Destructor Documentation

template<typename Type >
fawkes::LockList< Type >::LockList ( )

Constructor.

Definition at line 115 of file lock_list.h.

template<typename Type>
fawkes::LockList< Type >::LockList ( const LockList< Type > &  ll)

Copy constructor.

Parameters:
llLockList to copy

Definition at line 121 of file lock_list.h.

template<typename Type>
virtual fawkes::LockList< Type >::~LockList ( )
inlinevirtual

Destructor.

Definition at line 56 of file lock_list.h.


Member Function Documentation

template<typename Type >
void fawkes::LockList< Type >::lock ( ) const
virtual

Lock list.

Definition at line 128 of file lock_list.h.

Referenced by fawkes::WorldInfoTransceiver::add_handler(), fawkes::PluginManager::add_listener(), fawkes::ConfigNetworkHandler::client_disconnected(), fawkes::ConfigNetworkHandler::config_comment_changed(), fawkes::ConfigNetworkHandler::config_value_changed(), fawkes::PluginManager::config_value_changed(), fawkes::ConfigNetworkHandler::config_value_erased(), fawkes::PluginManager::config_value_erased(), fawkes::PluginManager::fam_event(), FvBaseThread::finalize(), fawkes::ThreadManager::force_remove(), fawkes::PluginManager::get_loaded_plugins(), fawkes::NetworkLogger::handle_network_message(), fawkes::PluginManager::init_pinfo_cache(), fawkes::NetworkLogger::log_debug(), fawkes::NetworkLogger::log_error(), fawkes::NetworkLogger::log_info(), fawkes::NetworkLogger::log_warn(), firevision::FuseServer::loop(), fawkes::PluginNetworkHandler::loop(), fawkes::LockList< Type >::operator=(), fawkes::WorldInfoTransceiver::recv(), FvBaseThread::release_camctrl(), fawkes::NetworkLogger::tlog_debug(), fawkes::NetworkLogger::tlog_error(), fawkes::NetworkLogger::tlog_info(), fawkes::NetworkLogger::tlog_warn(), fawkes::NetworkLogger::vlog_debug(), fawkes::NetworkLogger::vlog_error(), fawkes::NetworkLogger::vlog_info(), fawkes::NetworkLogger::vlog_warn(), fawkes::NetworkLogger::vtlog_debug(), fawkes::NetworkLogger::vtlog_error(), fawkes::NetworkLogger::vtlog_info(), fawkes::NetworkLogger::vtlog_warn(), and fawkes::PluginManager::~PluginManager().

template<typename Type >
RefPtr< Mutex > fawkes::LockList< Type >::mutex ( ) const

Get access to the internal mutex.

Can be used with MutexLocker.

Returns:
internal mutex

Definition at line 182 of file lock_list.h.

Referenced by LaserPointCloudThread::loop().

template<typename Type>
LockList< Type > & fawkes::LockList< Type >::operator= ( const LockList< Type > &  ll)

Copy values from another LockList.

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

Parameters:
lllist to copy
Returns:
reference to this instance

Definition at line 190 of file lock_list.h.

References fawkes::LockList< Type >::lock(), and fawkes::LockList< Type >::unlock().

template<typename Type>
LockList< Type > & fawkes::LockList< Type >::operator= ( const std::list< Type > &  l)

Copy values from a standard list.

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

Parameters:
llist to copy
Returns:
reference to this instance

Definition at line 208 of file lock_list.h.

template<typename Type>
void fawkes::LockList< Type >::push_back_locked ( const Type &  x)

Push element to list at back with lock protection.

Parameters:
xelement to add

Definition at line 152 of file lock_list.h.

Referenced by fawkes::FileAlterationMonitor::add_filter(), fawkes::FileAlterationMonitor::add_listener(), fawkes::Thread::add_notification_listener(), and fawkes::ConfigNetworkHandler::loop().

template<typename Type>
void fawkes::LockList< Type >::push_front_locked ( const Type &  x)

Push element to list at front with lock protection.

Parameters:
xelement to add

Definition at line 162 of file lock_list.h.

template<typename Type >
bool fawkes::LockList< Type >::try_lock ( ) const
virtual

Try to lock list.

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

Definition at line 136 of file lock_list.h.

template<typename Type >
void fawkes::LockList< Type >::unlock ( ) const
virtual

Unlock list.

Definition at line 144 of file lock_list.h.

Referenced by fawkes::WorldInfoTransceiver::add_handler(), fawkes::PluginManager::add_listener(), fawkes::ConfigNetworkHandler::client_disconnected(), fawkes::ConfigNetworkHandler::config_comment_changed(), fawkes::ConfigNetworkHandler::config_value_changed(), fawkes::PluginManager::config_value_changed(), fawkes::ConfigNetworkHandler::config_value_erased(), fawkes::PluginManager::config_value_erased(), fawkes::PluginManager::fam_event(), FvBaseThread::finalize(), fawkes::ThreadManager::force_remove(), fawkes::PluginManager::get_loaded_plugins(), fawkes::NetworkLogger::handle_network_message(), fawkes::PluginManager::init_pinfo_cache(), fawkes::NetworkLogger::log_debug(), fawkes::NetworkLogger::log_error(), fawkes::NetworkLogger::log_info(), fawkes::NetworkLogger::log_warn(), firevision::FuseServer::loop(), fawkes::PluginNetworkHandler::loop(), fawkes::LockList< Type >::operator=(), fawkes::WorldInfoTransceiver::recv(), FvBaseThread::release_camctrl(), fawkes::NetworkLogger::tlog_debug(), fawkes::NetworkLogger::tlog_error(), fawkes::NetworkLogger::tlog_info(), fawkes::NetworkLogger::tlog_warn(), fawkes::NetworkLogger::vlog_debug(), fawkes::NetworkLogger::vlog_error(), fawkes::NetworkLogger::vlog_info(), fawkes::NetworkLogger::vlog_warn(), fawkes::NetworkLogger::vtlog_debug(), fawkes::NetworkLogger::vtlog_error(), fawkes::NetworkLogger::vtlog_info(), fawkes::NetworkLogger::vtlog_warn(), and fawkes::PluginManager::~PluginManager().


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