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

Queue with a lock. More...

#include <>>

Inheritance diagram for fawkes::LockQueue< Type >:

Public Member Functions

 LockQueue ()
 Constructor.
 LockQueue (const LockQueue< Type > &ll)
 Copy constructor.
virtual ~LockQueue ()
 Destructor.
void lock () const
 Lock queue.
bool try_lock () const
 Try to lock queue.
void unlock () const
 Unlock list.
RefPtr< Mutexmutex () const
 Get access to the internal mutex.
void push_locked (const Type &x)
 Push element to queue with lock protection.
void pop_locked ()
 Pop element from queue with lock protection.
void clear ()
 Clear the queue.

Additional Inherited Members

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

Detailed Description

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

Queue with a lock.

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

See Also
Mutex
Author
Tim Niemueller

Definition at line 43 of file lock_queue.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 97 of file lock_queue.h.

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

Copy constructor.

Parameters
llLockQueue to copy

Definition at line 103 of file lock_queue.h.

template<typename Type >
fawkes::LockQueue< Type >::~LockQueue ( )
virtual

Destructor.

Definition at line 109 of file lock_queue.h.

Member Function Documentation

template<typename Type >
void fawkes::LockQueue< Type >::clear ( )
template<typename Type>
RefPtr<Mutex> fawkes::LockQueue< Type >::mutex ( ) const
inline

Get access to the internal mutex.

Can be used with MutexLocker.

Returns
internal mutex

Definition at line 72 of file lock_queue.h.

template<typename Type >
void fawkes::LockQueue< Type >::pop_locked ( )

Pop element from queue with lock protection.

Definition at line 149 of file lock_queue.h.

Referenced by fawkes::BlackBoardNetworkHandler::loop(), fawkes::ConfigNetworkHandler::loop(), and fawkes::PluginNetworkHandler::loop().

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

Try to lock queue.

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

Definition at line 123 of file lock_queue.h.


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