EThreadQueuePrivate< T > Class Template Reference

Definition of a private event thread message queue. More...

#include <etevent.h>

Inheritance diagram for EThreadQueuePrivate< T >:

Public Member Functions
	EThreadQueuePrivate ()
	Default constructor. More...
	~EThreadQueuePrivate ()
	Class destructor. More...
Void	init (Int nMsgCnt, Int threadId, Bool bMultipleWriters, EThreadQueueMode eMode)
	Initializes this public event thead message queue object. More...
Public Member Functions inherited from EThreadQueueBase< T >
Bool	push (const T &msg, Bool wait=True)
	Adds the specified message to the thread event queue. More...
Bool	pop (T &msg, Bool wait=True)
	Removes the next message from the thread event queue. More...
Bool	peek (T &msg, Bool wait=True)
	Retrievees the next message from the thread event queue without removing the message from the queue. More...
Bool	isInitialized ()
	Retrieves indication if this queue object has been initialized. More...
EThreadQueueMode	mode ()
	Retrieves the access mode associated with this queue object. More...

Friends
template<class TQueue , class TMessage >
class	EThreadEvent

Detailed Description

template<class T>
class EThreadQueuePrivate< T >

Definition of a private event thread message queue.

The template parameter to this class template is the class of for the message that will be stored in this event thread message queue. This class is derived from template <class t>=""> class EThreadQueueBase.

Template Parameters

T	the event message class name.

Constructor & Destructor Documentation

EThreadQueuePrivate()

template<class T >

EThreadQueuePrivate< T >::EThreadQueuePrivate ( )

inline

Default constructor.

~EThreadQueuePrivate()

template<class T >

EThreadQueuePrivate< T >::~EThreadQueuePrivate ( )

inline

Class destructor.

Member Function Documentation

init()

template<class T >

Void EThreadQueuePrivate< T >::init ( Int  nMsgCnt, Int  threadId, Bool  bMultipleWriters, EThreadQueueMode  eMode  )

inline

Initializes this public event thead message queue object.

Parameters

nMsgCnt	the maximum number of event messages that can exist in the queue at a time.
threadId	the public thread identifier.
bMultipleWriters	indicates if more than can be more than one instance can write to the queue at a time. If True, inserting messages into the queue will be controled by a mutex.
eMode	indicates the desired access mode.

Friends And Related Function Documentation

EThreadEvent

template<class T >

template<class TQueue , class TMessage >

friend class EThreadEvent

friend

---

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

• /home/vagrant/share/code/epctools/include/epc/etevent.h