DtAssistantRemovalMsg Class Reference

The DtAssistantRemovalMsg defines a wrapper for the RTI Assistant removal message used by Assistants to inform other Assistants that they are shutting down and should be removed from any Assistant lists. More...

Inheritance diagram for DtAssistantRemovalMsg:

Collaboration diagram for DtAssistantRemovalMsg:

List of all members.

Public Member Functions
	DtAssistantRemovalMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantRemovalMsg (const DtNetAssistantRemovalMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantRemovalMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData () const
	Print the data section.
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantPeer *conn, DtAssistantRemovalCb cb, void *usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantRemovalCb cb, void *usr)
Protected Member Functions
virtual DtNetAssistantRemovalMsg *	netAssistantRemovalMsg ()
	The network representation for the removal message.
virtual const DtNetAssistantRemovalMsg *	netAssistantRemovalMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantQueryMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtAssistantRemovalMsg defines a wrapper for the RTI Assistant removal message used by Assistants to inform other Assistants that they are shutting down and should be removed from any Assistant lists.

---

Constructor & Destructor Documentation

DtAssistantRemovalMsg::DtAssistantRemovalMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantRemovalMsg::DtAssistantRemovalMsg	(	const DtNetAssistantRemovalMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetAssistantRemovalMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantRemovalMsg::~DtAssistantRemovalMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtAssistantRemovalMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantRemovalCb	cb,
		void *	usr
	)		[static]

Adds or removes a callback with the given Assistant peer for this message type.

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantRemovalMsgKind.

Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().

DtAssistantMsg * DtAssistantRemovalMsg::clone

(

bool

copy = true

)

const [virtual]

Return a copy/empty object of the same type as this.

Implements DtAssistantMsg.

References DtAssistantRemovalMsg(), and netAssistantRemovalMsg().

DtAssistantMsg * DtAssistantRemovalMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creators.

References DtAssistantRemovalMsg().

DtAssistantMsg * DtAssistantRemovalMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtAssistantRemovalMsg().

DtAssistantMsgKind DtAssistantRemovalMsg::internalMsgKind

(

)

[protected, virtual]

Returns the kind of a DtAssistantQueryMsg message.

Implements DtAssistantMsg.

References DtAssistantRemovalMsgKind.

Referenced by DtAssistantRemovalMsg().

int DtAssistantRemovalMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantRemovalMsg().

DtNetAssistantRemovalMsg * DtAssistantRemovalMsg::netAssistantRemovalMsg

(

)

[protected, virtual]

The network representation for the removal message.

Referenced by clone().

const DtNetAssistantRemovalMsg * DtAssistantRemovalMsg::netAssistantRemovalMsg

(

)

const [protected, virtual]

void DtAssistantRemovalMsg::printData

(

)

const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantRemovalMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantRemovalCb	cb,
		void *	usr
	)		[static]

References DtAssistantRemovalMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

Referenced by DtAssistantConnectionInfoMgr::~DtAssistantConnectionInfoMgr().

---

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

• assistantRemovalMsg.h
• assistantRemovalMsg.cxx