The DtAssistantWwwCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an Www component to its connected RTI Assistant. More...

Inheritance diagram for DtAssistantWwwCompInfoMsg:

Collaboration diagram for DtAssistantWwwCompInfoMsg:

Public Member Functions
	DtAssistantWwwCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantWwwCompInfoMsg (const DtNetAssistantWwwCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantWwwCompInfoMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setWebSpyIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set the web spy host IP address.
virtual MAKRti::DtInetAddr	webSpyIpAddress () const
	Get the web spy host IP address.
virtual void	setWebSpyHttpPort (int port)
	Set the web spy HTTP port number.
virtual int	webSpyHttpPort () const
	Get the web spy HTTP port number.
virtual void	setWebSpyRtiPort (int port)
	Set the web spy RTI port number.
virtual int	webSpyRtiPort () const
	Get the web spy RTI port number.
virtual void	setLogFilename (const MAKRti::DtFilename &filename)
	Set component log filename.
virtual MAKRti::DtFilename	logFilename () const
	Get component log filename.
virtual void	setNotifyLevel (DtNotifyLevelType level)
	Set notify level.
virtual DtNotifyLevelType	notifyLevel () const
	Get notify level.
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)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantWwwCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantWwwCompInfoCb 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 DtNetAssistantWwwCompInfoMsg *	netAssistantWwwCompInfoMsg ()
	The network representation for the component information.
virtual const DtNetAssistantWwwCompInfoMsg *	netAssistantWwwCompInfoMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantWwwCompInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setLogFilenameSize (unsigned long size)
	Set/Get log filename size.
virtual unsigned long	logFilenameSize () const
virtual const char *	logFilenamePtr () const
	Return pointer to log filename location in message.
virtual char *	logFilenamePtr ()
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 DtAssistantWwwCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an Www component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantWwwCompInfoMsg::DtAssistantWwwCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantWwwCompInfoMsg::DtAssistantWwwCompInfoMsg	(	const DtNetAssistantWwwCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantWwwCompInfoMsg::~DtAssistantWwwCompInfoMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantWwwCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantWwwCompInfoCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantWwwCompInfoMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

DtAssistantMsg * DtAssistantWwwCompInfoMsg::clone ( bool copy = true ) const

virtual

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

Implements DtAssistantMsg.

References DtAssistantWwwCompInfoMsg(), and netAssistantWwwCompInfoMsg().

DtAssistantMsg * DtAssistantWwwCompInfoMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creators.

References DtAssistantWwwCompInfoMsg().

DtAssistantMsg * DtAssistantWwwCompInfoMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantWwwCompInfoMsg().

DtAssistantMsgKind DtAssistantWwwCompInfoMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantWwwCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantWwwCompInfoMsgKind.

Referenced by DtAssistantWwwCompInfoMsg().

DtFilename DtAssistantWwwCompInfoMsg::logFilename ( ) const

virtual

Get component log filename.

References logFilenamePtr(), and logFilenameSize().

Referenced by printData(), and DtAssistantComponentMgr::processWwwCompInfoMsg().

const char * DtAssistantWwwCompInfoMsg::logFilenamePtr ( ) const

protectedvirtual

Return pointer to log filename location in message.

References netAssistantWwwCompInfoMsg().

Referenced by logFilename(), and setLogFilename().

char * DtAssistantWwwCompInfoMsg::logFilenamePtr ( )

protectedvirtual

References netAssistantWwwCompInfoMsg().

unsigned long DtAssistantWwwCompInfoMsg::logFilenameSize ( ) const

protectedvirtual

References DtNetAssistantWwwCompInfoMsg::logFilenameSize, and netAssistantWwwCompInfoMsg().

Referenced by logFilename(), and setLogFilename().

int DtAssistantWwwCompInfoMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantWwwCompInfoMsg().

DtNetAssistantWwwCompInfoMsg * DtAssistantWwwCompInfoMsg::netAssistantWwwCompInfoMsg ( )

protectedvirtual

The network representation for the component information.

Referenced by clone(), logFilenamePtr(), logFilenameSize(), notifyLevel(), setLogFilenameSize(), setNotifyLevel(), setWebSpyHttpPort(), setWebSpyIpAddress(), setWebSpyRtiPort(), webSpyHttpPort(), webSpyIpAddress(), and webSpyRtiPort().

const DtNetAssistantWwwCompInfoMsg * DtAssistantWwwCompInfoMsg::netAssistantWwwCompInfoMsg ( ) const

protectedvirtual

DtNotifyLevelType DtAssistantWwwCompInfoMsg::notifyLevel ( ) const

virtual

Get notify level.

References netAssistantWwwCompInfoMsg().

Referenced by printData().

void DtAssistantWwwCompInfoMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References logFilename(), notifyLevel(), webSpyHttpPort(), webSpyIpAddress(), and webSpyRtiPort().

void DtAssistantWwwCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantWwwCompInfoCb	cb,
		void *	usr
	)

static

References DtAssistantWwwCompInfoMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantComponentMgr::~DtAssistantComponentMgr().

void DtAssistantWwwCompInfoMsg::setLogFilename ( const MAKRti::DtFilename & filename )

virtual

Set component log filename.

References rti1516e::insertBytes(), logFilenamePtr(), logFilenameSize(), and setLogFilenameSize().

Referenced by DtRtiAssistantWwwClient::sendClientInfo().

void DtAssistantWwwCompInfoMsg::setLogFilenameSize ( unsigned long size )

protectedvirtual

Set/Get log filename size.

References DtNetAssistantWwwCompInfoMsg::logFilenameSize, and netAssistantWwwCompInfoMsg().

Referenced by setLogFilename().

void DtAssistantWwwCompInfoMsg::setNotifyLevel ( DtNotifyLevelType level )

virtual

Set notify level.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::notifyLevel.

Referenced by DtRtiAssistantWwwClient::sendClientInfo().

void DtAssistantWwwCompInfoMsg::setWebSpyHttpPort ( int port )

virtual

Set the web spy HTTP port number.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::webSpyHttpPort.

Referenced by DtRtiAssistantWwwClient::sendClientInfo().

void DtAssistantWwwCompInfoMsg::setWebSpyIpAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set the web spy host IP address.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::webSpyIpAddress.

Referenced by DtRtiAssistantWwwClient::sendClientInfo().

void DtAssistantWwwCompInfoMsg::setWebSpyRtiPort ( int port )

virtual

Set the web spy RTI port number.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::webSpyRtiPort.

Referenced by DtRtiAssistantWwwClient::sendClientInfo().

int DtAssistantWwwCompInfoMsg::webSpyHttpPort ( ) const

virtual

Get the web spy HTTP port number.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::webSpyHttpPort.

Referenced by printData(), and DtAssistantComponentMgr::processWwwCompInfoMsg().

DtInetAddr DtAssistantWwwCompInfoMsg::webSpyIpAddress ( ) const

virtual

Get the web spy host IP address.

References netAssistantWwwCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processWwwCompInfoMsg().

int DtAssistantWwwCompInfoMsg::webSpyRtiPort ( ) const

virtual

Get the web spy RTI port number.

References netAssistantWwwCompInfoMsg(), and DtNetAssistantWwwCompInfoMsg::webSpyRtiPort.

Referenced by printData(), and DtAssistantComponentMgr::processWwwCompInfoMsg().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation