makVrv::DtAsynchronousEventQueue Class Reference

The asynchronous event queue. More...

Inheritance diagram for makVrv::DtAsynchronousEventQueue:

Public Member Functions
void	initializeInThread ()
	This function should be called once in the thread which will execute these functions.
virtual void	postEvent (const Event &signal)
	Override the default add event, this function does nothing as asynchronous event queues do not communicate back to the main thread.
Secondary thread functions
virtual void	processEvents ()
	this function should be called frequently in the thread's, usually in it's tick loop.
Public Member Functions inherited from makVrv::DtEventQueueInterface
virtual	~DtEventQueueInterface ()
DtVirtualBaseClass *	findInstance (const std::string &className)
	Find a signaler interface.
void	registerInstance (const std::string &className, DtVirtualBaseClass *instance)
	Register an signaler base interface.
void	executeEvents (const SharedEventList &signalList)
	Take a unique pointer to a list of events, execute each event and delete the list.

Static Public Member Functions
static DtAsynchronousEventQueue *	findThisThreadEventQueue ()
	Return the asynchronous event queue for this thread.

Protected Member Functions
	DtAsynchronousEventQueue ()
	Create and destroy asynchronous event queues the the MainEventQueue.
	~DtAsynchronousEventQueue ()
Main thread functions
void	queueSharedEventList (SharedEventList sharedEvents)
	This function is called by the DtMainEventQueue.
Protected Member Functions inherited from makVrv::DtEventQueueInterface
	DtEventQueueInterface ()

Protected Attributes
DtLockedBufferedQueue < SharedEventList >	myQueuedLists
Protected Attributes inherited from makVrv::DtEventQueueInterface
InstanceMap	myInstanceMap

Friends
class	DtMainEventQueue

Additional Inherited Members
Public Types inherited from makVrv::DtEventQueueInterface
typedef boost::function< void(DtEventQueueInterface *) >	Event
typedef std::vector< Event >	EventList
typedef DtBoost::shared_ptr < EventList >	SharedEventList
Protected Types inherited from makVrv::DtEventQueueInterface
typedef std::map< std::string, DtVirtualBaseClass * >	InstanceMap

Detailed Description

The asynchronous event queue.

To create an asynchronous event queue the the makVrv::DtMainEventQueue class.

Constructor & Destructor Documentation

makVrv::DtAsynchronousEventQueue::DtAsynchronousEventQueue ( )

protected

Create and destroy asynchronous event queues the the MainEventQueue.

makVrv::DtAsynchronousEventQueue::~DtAsynchronousEventQueue ( )

protected

Member Function Documentation

void makVrv::DtAsynchronousEventQueue::initializeInThread

(

)

This function should be called once in the thread which will execute these functions.

static DtAsynchronousEventQueue* makVrv::DtAsynchronousEventQueue::findThisThreadEventQueue ( )

static

Return the asynchronous event queue for this thread.

virtual void makVrv::DtAsynchronousEventQueue::postEvent ( const Event &  signal )

virtual

Override the default add event, this function does nothing as asynchronous event queues do not communicate back to the main thread.

Implements makVrv::DtEventQueueInterface.

virtual void makVrv::DtAsynchronousEventQueue::processEvents ( )

virtual

this function should be called frequently in the thread's, usually in it's tick loop.

Implements makVrv::DtEventQueueInterface.

void makVrv::DtAsynchronousEventQueue::queueSharedEventList ( SharedEventList  sharedEvents )

protected

This function is called by the DtMainEventQueue.

Friends And Related Function Documentation

friend class DtMainEventQueue

friend

Member Data Documentation

DtLockedBufferedQueue< SharedEventList > makVrv::DtAsynchronousEventQueue::myQueuedLists

protected

---

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

• include/vrvUtil/DtAsynchronousEventQueue.h