MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Protected Attributes
DtThreadSafeQueue< T > Class Template Reference

Very simple wrapper that provides thread-safe access to a basic queue pointers. More...

+ Inheritance diagram for DtThreadSafeQueue< T >:
+ Collaboration diagram for DtThreadSafeQueue< T >:

List of all members.

Public Member Functions

 DtThreadSafeQueue ()
 Ctor.
virtual ~DtThreadSafeQueue ()
 Dtor.
virtual void push_back (std::auto_ptr< T > elem)
 Push an element onto the back of the queue.
virtual void push_front (std::auto_ptr< T > elem)
 Push an element onto the front of the queue.
virtual std::auto_ptr< T > pop ()
 Pop an element from the front of the queue Returns 0 if queue is empty.
virtual size_t size () const

Protected Attributes

std::deque< T * > myQueue
 Data Members.
MAKRti::DtMutex myLock
 Lock for critical section access.

Detailed Description

template<class T>
class DtThreadSafeQueue< T >

Very simple wrapper that provides thread-safe access to a basic queue pointers.

Queue always assumes ownership of pointed to objects. This implies that when the queue is deleted all objects on the queue are deleted as well. This also implies that this queue may not be used to store arrays.

Warning:
This class is definitely not an STL compliant template, and it is
not 100% exception safe (lock may remain locked)

Constructor & Destructor Documentation

template<class T>
DtThreadSafeQueue< T >::DtThreadSafeQueue ( )

Ctor.

template<class T>
virtual DtThreadSafeQueue< T >::~DtThreadSafeQueue ( ) [virtual]

Dtor.


Member Function Documentation

template<class T>
virtual std::auto_ptr<T> DtThreadSafeQueue< T >::pop ( ) [inline, virtual]
template<class T>
virtual void DtThreadSafeQueue< T >::push_back ( std::auto_ptr< T >  elem) [inline, virtual]
template<class T>
virtual void DtThreadSafeQueue< T >::push_front ( std::auto_ptr< T >  elem) [inline, virtual]

Push an element onto the front of the queue.

template<class T>
virtual size_t DtThreadSafeQueue< T >::size ( ) const [inline, virtual]

Member Data Documentation

template<class T>
MAKRti::DtMutex DtThreadSafeQueue< T >::myLock [mutable, protected]

Lock for critical section access.

template<class T>
std::deque< T* > DtThreadSafeQueue< T >::myQueue [protected]

Data Members.


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)