DtAssistantShutdownMsg Class Reference

The DtAssistantShutdownMsg defines a wrapper for the messages sent to and from the Assistant to query for connection information and respond with the connection information. More...

Inheritance diagram for DtAssistantShutdownMsg:

Collaboration diagram for DtAssistantShutdownMsg:

List of all members.

Public Types
enum	DtShutdownEnum { DtDoNotShutdown = 0, DtRequestShutdown, DtForceShutdown }
Public Member Functions
	DtAssistantShutdownMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtAssistantShutdownMsg (const DtNetAssistantShutdownMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtAssistantShutdownMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setIsAssistantToAssistant (bool yesNo)
	Get / Set whether this is from an assistant to assistant client.
virtual bool	isAssistantToAssistant () const
virtual void	setForceShutdown (bool yesNo)
	Get / Set the shutdown value.
virtual bool	isForceShutdown () const
virtual void	printData () const
	Print the data section.
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static void	addCallback (DtRtiAssistantServer *conn, DtAssistantShutdownMsgCb cb, void *usr)
	Callback management.
static void	removeCallback (DtRtiAssistantServer *conn, DtAssistantShutdownMsgCb cb, void *usr)
static void	addCallback (DtAssistantMsgQueue *queue, DtAssistantShutdownMsgCb cb, void *usr)
static void	removeCallback (DtAssistantMsgQueue *queue, DtAssistantShutdownMsgCb cb, void *usr)
Protected Member Functions
virtual DtNetAssistantShutdownMsg *	netAssistantShutdownMsg ()
	The network representation.
virtual const DtNetAssistantShutdownMsg *	netAssistantShutdownMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantShutdownMsg Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtAssistantShutdownMsg defines a wrapper for the messages sent to and from the Assistant to query for connection information and respond with the connection information.

---

Member Enumeration Documentation

enum DtAssistantShutdownMsg::DtShutdownEnum

Enumerator:

DtDoNotShutdown
DtRequestShutdown
DtForceShutdown

---

Constructor & Destructor Documentation

DtAssistantShutdownMsg::DtAssistantShutdownMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtAssistantShutdownMsg::DtAssistantShutdownMsg	(	const DtNetAssistantShutdownMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtAssistantShutdownMsg::~DtAssistantShutdownMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtAssistantShutdownMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantShutdownMsgCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantShutdownMsgKind.

Referenced by DtRtiAssistant::initializeAssistantServer().

void DtAssistantShutdownMsg::addCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantShutdownMsgCb	cb,
		void *	usr
	)		[static]

References DtAssistantMsgQueue::addMsgCallback(), and DtAssistantShutdownMsgKind.

DtAssistantMsg * DtAssistantShutdownMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantShutdownMsg(), and netAssistantShutdownMsg().

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

Creator.

References DtAssistantShutdownMsg().

DtAssistantMsg * DtAssistantShutdownMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtAssistantShutdownMsg().

DtAssistantMsgKind DtAssistantShutdownMsg::internalMsgKind

(

)

[protected, virtual]

Returns the kind of a DtAssistantShutdownMsg Msg.

Implements DtAssistantMsg.

References DtAssistantShutdownMsgKind.

Referenced by DtAssistantShutdownMsg().

bool DtAssistantShutdownMsg::isAssistantToAssistant

(

)

const [virtual]

References DtNetAssistantShutdownMsg::assistant, and netAssistantShutdownMsg().

bool DtAssistantShutdownMsg::isForceShutdown

(

)

const [virtual]

References netAssistantShutdownMsg(), and DtNetAssistantShutdownMsg::shutdown.

Referenced by printData(), and DtRtiAssistant::processAssistantShutdownMsg().

int DtAssistantShutdownMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantShutdownMsg().

DtNetAssistantShutdownMsg * DtAssistantShutdownMsg::netAssistantShutdownMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), isAssistantToAssistant(), isForceShutdown(), setForceShutdown(), and setIsAssistantToAssistant().

const DtNetAssistantShutdownMsg * DtAssistantShutdownMsg::netAssistantShutdownMsg

(

)

const [protected, virtual]

void DtAssistantShutdownMsg::printData

(

)

const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References isForceShutdown().

void DtAssistantShutdownMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantShutdownMsgCb	cb,
		void *	usr
	)		[static]

References DtAssistantShutdownMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtRtiAssistant::~DtRtiAssistant().

void DtAssistantShutdownMsg::removeCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantShutdownMsgCb	cb,
		void *	usr
	)		[static]

References DtAssistantShutdownMsgKind, and DtAssistantMsgQueue::removeMsgCallback().

void DtAssistantShutdownMsg::setForceShutdown

(

bool

yesNo

)

[virtual]

Get / Set the shutdown value.

References netAssistantShutdownMsg(), and DtNetAssistantShutdownMsg::shutdown.

Referenced by DtRtiAssistantToAssistantClient::sendShutdownMessage().

void DtAssistantShutdownMsg::setIsAssistantToAssistant

(

bool

yesNo

)

[virtual]

Get / Set whether this is from an assistant to assistant client.

References DtNetAssistantShutdownMsg::assistant, and netAssistantShutdownMsg().

Referenced by DtRtiAssistantToAssistantClient::sendShutdownMessage().

---

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

• assistantShutdownMsg.h
• assistantShutdownMsg.cxx