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:

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.
Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual DtAssistantMsgKind	msgKind () const
	Get the message kind.
virtual void	print () const
	Printing functions.
virtual void	printHeader () const
virtual bool	isOk () const
	Message is good?
bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message.
virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int	sourceId () const
	Get/Set the ID of the source of this message.
virtual void	setSourceId (int id)
virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message.
virtual void	setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message.
virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int	destId () const
	Get/Set the ID of the destination of this message.
virtual void	setDestId (int id)
virtual int	compId () const
	Get/Set the related component's connection ID.
virtual void	setCompId (int compId)

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)
Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

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.
Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initAssistantMsg (const void *initial, int size, DtBufferPtr buffer)
void	initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address.
virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()
virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size.
virtual unsigned long	sourceHostSize () const
virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message.
virtual char *	sourceHostPtr ()

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 ( )

protectedvirtual

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

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantShutdownMsg().

DtNetAssistantShutdownMsg * DtAssistantShutdownMsg::netAssistantShutdownMsg ( )

protectedvirtual

The network representation.

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

const DtNetAssistantShutdownMsg * DtAssistantShutdownMsg::netAssistantShutdownMsg ( ) const

protectedvirtual

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