makVrv::DtMainEventQueue Class Reference

The main event queue should live in the main application thread and is used to communicate events to other threads. More...

Inheritance diagram for makVrv::DtMainEventQueue:

List of all members.

Public Member Functions
	DtMainEventQueue ()
	CTOR, typically there should only be one instance per main thread.
virtual	~DtMainEventQueue ()
	DTOR.
virtual void	postEvent (const Event &signal)
	Add an event to the queue.
virtual void	processEvents ()
	Should be called regularly (typically once per tick in main thread)
DtAsynchronousEventQueue *	createAsynchronousEventQueue ()
	be called in main thread, will start queuing all signals generated after this point, the pointer is designed to be passed to a secondary thread.
bool	destroyAsynchronousEventQueue (DtAsynchronousEventQueue *secondary)
	be called in main thread, typically after the secondary thread has stopped.
Protected Types
typedef std::vector < DtAsynchronousEventQueue * >	ThreadQueueList
Protected Member Functions
void	distributeEvents ()
	Distribute all added events to the secondary queues.
Protected Attributes
ThreadQueueList	mySecondaryQueues
SharedEventList	myEventsToDistribute

---

Detailed Description

The main event queue should live in the main application thread and is used to communicate events to other threads.

Events are typically generated by event_signal instances.

---

Member Typedef Documentation

typedef std::vector<DtAsynchronousEventQueue*> makVrv::DtMainEventQueue::ThreadQueueList [protected]

---

Constructor & Destructor Documentation

makVrv::DtMainEventQueue::DtMainEventQueue

(

)

CTOR, typically there should only be one instance per main thread.

virtual makVrv::DtMainEventQueue::~DtMainEventQueue

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtMainEventQueue::postEvent

(

const Event &

signal

)

[virtual]

Add an event to the queue.

The main event queue will pass these events to any asynchronous event queues, or simply delete them.

Implements makVrv::DtEventQueueInterface.

virtual void makVrv::DtMainEventQueue::processEvents

(

)

[virtual]

Should be called regularly (typically once per tick in main thread)

Implements makVrv::DtEventQueueInterface.

DtAsynchronousEventQueue* makVrv::DtMainEventQueue::createAsynchronousEventQueue

(

)

be called in main thread, will start queuing all signals generated after this point, the pointer is designed to be passed to a secondary thread.

bool makVrv::DtMainEventQueue::destroyAsynchronousEventQueue

(

DtAsynchronousEventQueue *

secondary

)

be called in main thread, typically after the secondary thread has stopped.

void makVrv::DtMainEventQueue::distributeEvents

(

)

[protected]

Distribute all added events to the secondary queues.

This is called by processEvents.

---

Member Data Documentation

ThreadQueueList makVrv::DtMainEventQueue::mySecondaryQueues [protected]

SharedEventList makVrv::DtMainEventQueue::myEventsToDistribute [protected]

---

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

• include/vrvUtil/DtMainEventQueue.h