DtAssistantMsgQueue Class Reference

Maintains a queue of RTI Assistant messages. More...

Collaboration diagram for DtAssistantMsgQueue:

List of all members.

Classes
struct	DtAssistantMsgQueueItem
Public Member Functions
	DtAssistantMsgQueue ()
	Constructor.
virtual	~DtAssistantMsgQueue ()
	Destructor.
virtual void	addMsgCallback (DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
	Add message callback.
virtual void	removeMsgCallback (DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
	Remove message callback.
virtual void	addMsg (const DtAssistantMsg &msg, int compId)
	Add message to queue.
virtual void	beginProcessMsg ()
	Begin processing for the next message, calling any registered callbacks.
virtual void	finishProcessMsg ()
	Finish processing for the current message.
virtual const DtAssistantMsg *	currMsg () const
	Get the current message being processed.
virtual int	currentCompId () const
	Get the component ID from which the current message being processed was received.
Protected Attributes
DtList	myMsgList
	List of messages in the queue.
DtAssistantMsgQueueItem *	myCurrMsgItem
	The item in the queue currently being processed.
DtAssistantMsgCbMgr	myMsgCbMgr
	Callback manager.
Private Member Functions
	DtAssistantMsgQueue (const DtAssistantMsgQueue &)
	Copy constructor not implemented.
DtAssistantMsgQueue &	operator= (const DtAssistantMsgQueue &)
	Assignment not implemented.

---

Detailed Description

Maintains a queue of RTI Assistant messages.

DtAssistantMsgQueue queues messages for later processing. Only one message from the queue may be processed at any given time. Callback functions may be registered with the queue to process messages.

---

Constructor & Destructor Documentation

DtAssistantMsgQueue::DtAssistantMsgQueue

(

)

Constructor.

DtAssistantMsgQueue::~DtAssistantMsgQueue

(

)

[virtual]

Destructor.

References DtAssistantMsgQueue::DtAssistantMsgQueueItem::msg, and myMsgList.

DtAssistantMsgQueue::DtAssistantMsgQueue

(

const DtAssistantMsgQueue &

)

[private]

Copy constructor not implemented.

---

Member Function Documentation

void DtAssistantMsgQueue::addMsg	(	const DtAssistantMsg &	msg,
		int	compId
	)		[virtual]

Add message to queue.

References DtAssistantMsg::clone(), DtAssistantMsgQueue::DtAssistantMsgQueueItem::compId, DtAssistantMsgQueue::DtAssistantMsgQueueItem::msg, and myMsgList.

Referenced by DtAssistantConnQueryMgr::addConnQueryMsgToQueue(), DtAssistantLicenseQueryMgr::addLicQueryMsgToQueue(), and DtAssistantPopupMsgMgr::addPopupMsgToQueue().

void DtAssistantMsgQueue::addMsgCallback	(	DtAssistantMsgKind	msgKind,
		DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add message callback.

References myMsgCbMgr.

Referenced by DtAssistantShutdownMsg::addCallback(), DtAssistantLicQueryMsg::addCallback(), DtAssistantPopupMsg::addCallback(), DtAssistantCommandMsg::addCallback(), and DtAssistantConnQueryMsg::addCallback().

void DtAssistantMsgQueue::beginProcessMsg

(

)

[virtual]

Begin processing for the next message, calling any registered callbacks.

Does nothing if another message is already being processed.

References DtAssistantMsgQueue::DtAssistantMsgQueueItem::msg, myCurrMsgItem, myMsgCbMgr, and myMsgList.

Referenced by DtAssistantPopupMsgMgr::tick(), DtAssistantLicenseQueryMgr::tick(), and DtAssistantConnQueryMgr::tick().

int DtAssistantMsgQueue::currentCompId

(

)

const [virtual]

Get the component ID from which the current message being processed was received.

References DtAssistantMsgQueue::DtAssistantMsgQueueItem::compId, and myCurrMsgItem.

Referenced by DtAssistantConnQueryMgr::closeConnQueryDialog(), DtAssistantLicenseQueryMgr::closeLicQueryDialogForId(), DtAssistantConnQueryMgr::processConnQueryMsg(), DtAssistantConnQueryMgr::processConnQueryResults(), DtAssistantLicenseQueryMgr::processLicQueryMsg(), DtAssistantLicenseQueryMgr::processLicQueryResults(), and DtAssistantPopupMsgMgr::processPopupMsg().

const DtAssistantMsg * DtAssistantMsgQueue::currMsg

(

)

const [virtual]

Get the current message being processed.

References DtAssistantMsgQueue::DtAssistantMsgQueueItem::msg, and myCurrMsgItem.

void DtAssistantMsgQueue::finishProcessMsg

(

)

[virtual]

Finish processing for the current message.

Must be called before before beginProcessMsg will allow a new message to be processed.

References DtAssistantMsgQueue::DtAssistantMsgQueueItem::msg, and myCurrMsgItem.

Referenced by DtAssistantConnQueryMgr::processConnQueryMsg(), DtAssistantConnQueryMgr::processConnQueryResults(), DtAssistantLicenseQueryMgr::processLicQueryMsg(), DtAssistantLicenseQueryMgr::processLicQueryResults(), and DtAssistantPopupMsgMgr::processPopupDismiss().

DtAssistantMsgQueue& DtAssistantMsgQueue::operator=

(

const DtAssistantMsgQueue &

)

[private]

Assignment not implemented.

void DtAssistantMsgQueue::removeMsgCallback	(	DtAssistantMsgKind	msgKind,
		DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Remove message callback.

References myMsgCbMgr.

Referenced by DtAssistantShutdownMsg::removeCallback(), DtAssistantLicQueryMsg::removeCallback(), DtAssistantPopupMsg::removeCallback(), DtAssistantCommandMsg::removeCallback(), and DtAssistantConnQueryMsg::removeCallback().

---

Member Data Documentation

DtAssistantMsgQueueItem* DtAssistantMsgQueue::myCurrMsgItem [protected]

The item in the queue currently being processed.

Referenced by beginProcessMsg(), currentCompId(), currMsg(), and finishProcessMsg().

DtAssistantMsgCbMgr DtAssistantMsgQueue::myMsgCbMgr [protected]

Callback manager.

Referenced by addMsgCallback(), beginProcessMsg(), and removeMsgCallback().

DtList DtAssistantMsgQueue::myMsgList [protected]

List of messages in the queue.

Referenced by addMsg(), beginProcessMsg(), and ~DtAssistantMsgQueue().

---

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

• assistantMsgQueue.h
• assistantMsgQueue.cxx