DtVrfObjectMessageExecutive Class Reference

Callback manager for DtVrfObjectMessage receipt. More...

List of all members.

Public Member Functions
	DtVrfObjectMessageExecutive ()
virtual	~DtVrfObjectMessageExecutive ()
virtual void	processMessage (const DtVrfObjectMessage *message)
	Call any appropriate callbacks that have been registered for this message.
virtual void	removeAllCallbacks ()
	Removes all callbacks that have been registered with this executive.
virtual void	addMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called for every message that goes though this message executive.
virtual void	removeMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called for every message that goes though this message executive.
virtual void	addMessageCallback (int type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific type of object message is processed.
virtual void	removeMessageCallback (int type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific type of object message is processed.
virtual void	addMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific category of object message is processed.
virtual void	removeMessageCallbackByCategory (int category, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific category of object message is processed.
Protected Types
typedef DtCallbackList< const DtVrfObjectMessage * >	DtObjectMessageCallbackList
typedef DtBoost::shared_ptr < DtObjectMessageCallbackList >	DtObjectMessageCallbackListPtr
typedef std::map< int, DtObjectMessageCallbackListPtr >	DtObjectMessageCallbackMap
Protected Attributes
DtObjectMessageCallbackMap	myObjectMessageCallbacksByType
	Callbacks registered on a specific message type.
DtObjectMessageCallbackList	myObjectMessageCallbacks
	Callbacks registered on all messages.
DtObjectMessageCallbackMap	myObjectMessageCallbacksByCategory
	Callbacks registered on specific categories.
Private Member Functions
	DtVrfObjectMessageExecutive (const DtVrfObjectMessageExecutive &orig)
	Not implemented.
DtVrfObjectMessageExecutive &	operator= (const DtVrfObjectMessageExecutive &orig)
	Not implemented.

---

Detailed Description

Callback manager for DtVrfObjectMessage receipt.

Callbacks can be registered on various attributes of a message, and will be invoked properly whenever processMessage() is called.

---

Member Typedef Documentation

typedef DtCallbackList<const DtVrfObjectMessage*> DtVrfObjectMessageExecutive::DtObjectMessageCallbackList [protected]

typedef DtBoost::shared_ptr<DtObjectMessageCallbackList> DtVrfObjectMessageExecutive::DtObjectMessageCallbackListPtr [protected]

typedef std::map<int, DtObjectMessageCallbackListPtr> DtVrfObjectMessageExecutive::DtObjectMessageCallbackMap [protected]

---

Constructor & Destructor Documentation

DtVrfObjectMessageExecutive::DtVrfObjectMessageExecutive

(

const DtVrfObjectMessageExecutive &

orig

)

[private]

Not implemented.

DtVrfObjectMessageExecutive::DtVrfObjectMessageExecutive

(

)

virtual DtVrfObjectMessageExecutive::~DtVrfObjectMessageExecutive

(

)

[virtual]

---

Member Function Documentation

DtVrfObjectMessageExecutive& DtVrfObjectMessageExecutive::operator=

(

const DtVrfObjectMessageExecutive &

orig

)

[private]

Not implemented.

virtual void DtVrfObjectMessageExecutive::processMessage

(

const DtVrfObjectMessage *

message

)

[virtual]

Call any appropriate callbacks that have been registered for this message.

virtual void DtVrfObjectMessageExecutive::addMessageCallback	(	DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called for every message that goes though this message executive.

virtual void DtVrfObjectMessageExecutive::removeMessageCallback	(	DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called for every message that goes though this message executive.

virtual void DtVrfObjectMessageExecutive::addMessageCallback	(	int	type,
		DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called when a specific type of object message is processed.

The type parameter is the content type of the message.

virtual void DtVrfObjectMessageExecutive::removeMessageCallback	(	int	type,
		DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called when a specific type of object message is processed.

The type parameter is the content type of the message.

virtual void DtVrfObjectMessageExecutive::addMessageCallbackByCategory	(	int	category,
		DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called when a specific category of object message is processed.

Categories are general message types such as: DtTaskMessageType, DtReportMessageType, DtSetDataRequestMessageType, and DtAdminMessageType.

virtual void DtVrfObjectMessageExecutive::removeMessageCallbackByCategory	(	int	category,
		DtVrfObjectMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Callback which is called when a specific category of object message is processed.

Categories are general message types such as: DtTaskMessageType, DtReportMessageType, DtSetDataRequestMessageType, and DtAdminMessageType.

virtual void DtVrfObjectMessageExecutive::removeAllCallbacks

(

)

[virtual]

Removes all callbacks that have been registered with this executive.

---

Member Data Documentation

DtObjectMessageCallbackMap DtVrfObjectMessageExecutive::myObjectMessageCallbacksByType [protected]

Callbacks registered on a specific message type.

DtObjectMessageCallbackList DtVrfObjectMessageExecutive::myObjectMessageCallbacks [protected]

Callbacks registered on all messages.

DtObjectMessageCallbackMap DtVrfObjectMessageExecutive::myObjectMessageCallbacksByCategory [protected]

Callbacks registered on specific categories.

---

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

• include/vrfmsgs/vrfObjectMessageExecutive.h