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

Inheritance diagram for DtAssistantRtiexecCompInfoMsg:

Collaboration diagram for DtAssistantRtiexecCompInfoMsg:

List of all members.

Public Member Functions
	DtAssistantRtiexecCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantRtiexecCompInfoMsg (const DtNetAssistantRtiexecCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantRtiexecCompInfoMsg ()
	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	setWebSpyPort (int port)
	Set the web spy port number.
virtual int	webSpyPort () const
	Get the web spy port number.
virtual void	setReliableIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set rtiexec's reliable forwarder IP address.
virtual MAKRti::DtInetAddr	reliableIpAddress () const
	Get rtiexec's reliable forwarder IP address.
virtual void	setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set rtiexec's best effort IP address.
virtual MAKRti::DtInetAddr	bestEffortIpAddress () const
	Get rtiexec's best effort IP address.
virtual void	setUdpPort (int port)
	Set rtiexec's forwarder UDP port number.
virtual int	udpPort () const
	Get rtiexec's forwarder UDP port number.
virtual void	setTcpPort (int port)
	Set rtiexec's forwarder TCP port number.
virtual int	tcpPort () const
	Get rtiexec's forwarder TCP port number.
virtual void	setFullCompliance (bool val)
	Set the flag indicating if rtiexec is running with full compliance.
virtual bool	fullCompliance () const
	Get the flag indicating if rtiexec is running with full compliance.
virtual void	setIsConnected (bool connected)
	Set whether or not the rtiexec has successfully connected to a forwarder.
virtual bool	isConnected () const
	Get whether the rtiexec has successfully connected to a forwarder.
virtual void	setHostName (const MAKRti::DtString &name)
	Set rtiexec host name.
virtual MAKRti::DtString	hostName () const
	Get rtiexec host name.
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	setLicServer (const MAKRti::DtString &server)
	Set the license server used by the rtiexec.
virtual MAKRti::DtString	licServer () const
	Get rtiexec license server.
virtual int	forwarderPort () const
	Get the forwarder port.
virtual void	setForwarderPort (int forwarderPortToUse)
	Set the forwarder port.
virtual MAKRti::DtInetAddr	additionalForwarderConnection () const
	Get the optional additional forwarder to connect to.
virtual void	setAdditionalForwarderConnection (const MAKRti::DtInetAddr &addr)
	Set the optional additional forwarder to connect to.
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 (DtRtiAssistantServer conn, DtAssistantRtiexecCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantRtiexecCompInfoCb cb, void usr)
Protected Member Functions
virtual void	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
	Set the IP address family.
virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
	Get the IP address family.
virtual DtNetAssistantRtiexecCompInfoMsg *	netAssistantRtiexecCompInfoMsg ()
	The network representation for the rtiexec component information.
virtual const DtNetAssistantRtiexecCompInfoMsg *	netAssistantRtiexecCompInfoMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantRtiexecCompInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setHostNameSize (unsigned long size)
	Set/Get rtiexec host name size.
virtual unsigned long	hostNameSize () const
virtual const char *	hostNamePtr () const
	Return pointer to rtiexec host name location in message.
virtual char *	hostNamePtr ()
virtual void	setLogFilenameSize (unsigned long size)
	Set/Get log filename size.
virtual unsigned long	logFilenameSize () const
virtual const char *	logFilenamePtr () const
	Return pointer to component name location in message.
virtual char *	logFilenamePtr ()
virtual void	setLicServerSize (unsigned long size)
	Set/Get license server size.
virtual unsigned long	licServerSize () const
virtual const char *	licServerPtr () const
	Return pointer to license server location in message.
virtual char *	licServerPtr ()

Detailed Description

The DtAssistantRtiexecCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an rtiexec component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg	(	const DtNetAssistantRtiexecCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantRtiexecCompInfoMsg::~DtAssistantRtiexecCompInfoMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantRtiexecCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiexecCompInfoCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantRtiexecCompInfoMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

DtInetAddr DtAssistantRtiexecCompInfoMsg::additionalForwarderConnection ( ) const [virtual]

Get the optional additional forwarder to connect to.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

DtInetUtils::DtInetAddrFamily DtAssistantRtiexecCompInfoMsg::addressFamily ( ) const [protected, virtual]

Get the IP address family.

References netAssistantRtiexecCompInfoMsg().

Referenced by additionalForwarderConnection(), bestEffortIpAddress(), and reliableIpAddress().

DtInetAddr DtAssistantRtiexecCompInfoMsg::bestEffortIpAddress ( ) const [virtual]

Get rtiexec's best effort IP address.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

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

DtAssistantMsg * DtAssistantRtiexecCompInfoMsg::clone ( bool copy = true ) const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantRtiexecCompInfoMsg(), and netAssistantRtiexecCompInfoMsg().

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

Creators.

References DtAssistantRtiexecCompInfoMsg().

DtAssistantMsg * DtAssistantRtiexecCompInfoMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER ) [static]

References DtAssistantRtiexecCompInfoMsg().

int DtAssistantRtiexecCompInfoMsg::forwarderPort ( ) const [virtual]

Get the forwarder port.

References DtNetAssistantRtiexecCompInfoMsg::forwarderPort, and netAssistantRtiexecCompInfoMsg().

Referenced by DtAssistantComponentMgr::processRtiexecCompInfoMsg().

bool DtAssistantRtiexecCompInfoMsg::fullCompliance ( ) const [virtual]

Get the flag indicating if rtiexec is running with full compliance.

References DtNetAssistantRtiexecCompInfoMsg::fullCompliance, and netAssistantRtiexecCompInfoMsg().

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

DtString DtAssistantRtiexecCompInfoMsg::hostName ( ) const [virtual]

Get rtiexec host name.

References hostNamePtr(), and hostNameSize().

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

const char * DtAssistantRtiexecCompInfoMsg::hostNamePtr ( ) const [protected, virtual]

Return pointer to rtiexec host name location in message.

References netAssistantRtiexecCompInfoMsg().

Referenced by hostName(), logFilenamePtr(), and setHostName().

char * DtAssistantRtiexecCompInfoMsg::hostNamePtr ( ) [protected, virtual]

References netAssistantRtiexecCompInfoMsg().

unsigned long DtAssistantRtiexecCompInfoMsg::hostNameSize ( ) const [protected, virtual]

References DtNetAssistantRtiexecCompInfoMsg::hostNameSize, and netAssistantRtiexecCompInfoMsg().

Referenced by hostName(), logFilenamePtr(), and setHostName().

DtAssistantMsgKind DtAssistantRtiexecCompInfoMsg::internalMsgKind ( ) [protected, virtual]

Returns the kind of a DtAssistantRtiexecCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantRtiexecCompInfoMsgKind.

Referenced by DtAssistantRtiexecCompInfoMsg().

bool DtAssistantRtiexecCompInfoMsg::isConnected ( ) const [virtual]

Get whether the rtiexec has successfully connected to a forwarder.

References DtNetAssistantRtiexecCompInfoMsg::isConnected, and netAssistantRtiexecCompInfoMsg().

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

DtString DtAssistantRtiexecCompInfoMsg::licServer ( ) const [virtual]

Get rtiexec license server.

References licServerPtr(), and licServerSize().

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

const char * DtAssistantRtiexecCompInfoMsg::licServerPtr ( ) const [protected, virtual]

Return pointer to license server location in message.

References logFilenamePtr(), and logFilenameSize().

Referenced by licServer(), and setLicServer().

char * DtAssistantRtiexecCompInfoMsg::licServerPtr ( ) [protected, virtual]

References logFilenamePtr(), and logFilenameSize().

unsigned long DtAssistantRtiexecCompInfoMsg::licServerSize ( ) const [protected, virtual]

References DtNetAssistantRtiexecCompInfoMsg::licServerSize, and netAssistantRtiexecCompInfoMsg().

Referenced by licServer(), and setLicServer().

DtFilename DtAssistantRtiexecCompInfoMsg::logFilename ( ) const [virtual]

Get component log filename.

References logFilenamePtr(), and logFilenameSize().

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

const char * DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( ) const [protected, virtual]

Return pointer to component name location in message.

References hostNamePtr(), and hostNameSize().

Referenced by licServerPtr(), logFilename(), and setLogFilename().

char * DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( ) [protected, virtual]

References hostNamePtr(), and hostNameSize().

unsigned long DtAssistantRtiexecCompInfoMsg::logFilenameSize ( ) const [protected, virtual]

References DtNetAssistantRtiexecCompInfoMsg::logFilenameSize, and netAssistantRtiexecCompInfoMsg().

Referenced by licServerPtr(), logFilename(), and setLogFilename().

int DtAssistantRtiexecCompInfoMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantRtiexecCompInfoMsg().

DtNetAssistantRtiexecCompInfoMsg * DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( ) [protected, virtual]

The network representation for the rtiexec component information.

Referenced by additionalForwarderConnection(), addressFamily(), bestEffortIpAddress(), clone(), forwarderPort(), fullCompliance(), hostNamePtr(), hostNameSize(), isConnected(), licServerSize(), logFilenameSize(), notifyLevel(), reliableIpAddress(), setAdditionalForwarderConnection(), setAddressFamily(), setBestEffortIpAddress(), setForwarderPort(), setFullCompliance(), setHostNameSize(), setIsConnected(), setLicServerSize(), setLogFilenameSize(), setNotifyLevel(), setReliableIpAddress(), setTcpPort(), setUdpPort(), setWebSpyIpAddress(), setWebSpyPort(), tcpPort(), udpPort(), webSpyIpAddress(), and webSpyPort().

const DtNetAssistantRtiexecCompInfoMsg * DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( ) const [protected, virtual]

DtNotifyLevelType DtAssistantRtiexecCompInfoMsg::notifyLevel ( ) const [virtual]

Get notify level.

References netAssistantRtiexecCompInfoMsg().

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

void DtAssistantRtiexecCompInfoMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References bestEffortIpAddress(), fullCompliance(), hostName(), isConnected(), licServer(), logFilename(), notifyLevel(), reliableIpAddress(), tcpPort(), udpPort(), webSpyIpAddress(), and webSpyPort().

DtInetAddr DtAssistantRtiexecCompInfoMsg::reliableIpAddress ( ) const [virtual]

Get rtiexec's reliable forwarder IP address.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

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

void DtAssistantRtiexecCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiexecCompInfoCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantRtiexecCompInfoMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantComponentMgr::~DtAssistantComponentMgr().

void DtAssistantRtiexecCompInfoMsg::setAdditionalForwarderConnection ( const MAKRti::DtInetAddr & addr ) [virtual]

Set the optional additional forwarder to connect to.

References DtNetAssistantRtiexecCompInfoMsg::additionalForwarderAddress, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily fam ) [protected, virtual]

Set the IP address family.

References DtNetAssistantRtiexecCompInfoMsg::addressFamily, and netAssistantRtiexecCompInfoMsg().

Referenced by setBestEffortIpAddress(), and setReliableIpAddress().

void DtAssistantRtiexecCompInfoMsg::setBestEffortIpAddress ( const MAKRti::DtInetAddr & ipAddr ) [virtual]

Set rtiexec's best effort IP address.

References DtNetAssistantRtiexecCompInfoMsg::bestEffortIpAddress, netAssistantRtiexecCompInfoMsg(), and setAddressFamily().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setForwarderPort ( int forwarderPortToUse ) [virtual]

Set the forwarder port.

References DtNetAssistantRtiexecCompInfoMsg::forwarderPort, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setFullCompliance ( bool val ) [virtual]

Set the flag indicating if rtiexec is running with full compliance.

References DtNetAssistantRtiexecCompInfoMsg::fullCompliance, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setHostName ( const MAKRti::DtString & name ) [virtual]

Set rtiexec host name.

References hostNamePtr(), hostNameSize(), rti1516e::insertBytes(), and setHostNameSize().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setHostNameSize ( unsigned long size ) [protected, virtual]

Set/Get rtiexec host name size.

References DtNetAssistantRtiexecCompInfoMsg::hostNameSize, and netAssistantRtiexecCompInfoMsg().

Referenced by setHostName().

void DtAssistantRtiexecCompInfoMsg::setIsConnected ( bool connected ) [virtual]

Set whether or not the rtiexec has successfully connected to a forwarder.

References DtNetAssistantRtiexecCompInfoMsg::isConnected, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setLicServer ( const MAKRti::DtString & server ) [virtual]

Set the license server used by the rtiexec.

References rti1516e::insertBytes(), licServerPtr(), licServerSize(), and setLicServerSize().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setLicServerSize ( unsigned long size ) [protected, virtual]

Set/Get license server size.

References DtNetAssistantRtiexecCompInfoMsg::licServerSize, and netAssistantRtiexecCompInfoMsg().

Referenced by setLicServer().

void DtAssistantRtiexecCompInfoMsg::setLogFilename ( const MAKRti::DtFilename & filename ) [virtual]

Set component log filename.

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

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setLogFilenameSize ( unsigned long size ) [protected, virtual]

Set/Get log filename size.

References DtNetAssistantRtiexecCompInfoMsg::logFilenameSize, and netAssistantRtiexecCompInfoMsg().

Referenced by setLogFilename().

void DtAssistantRtiexecCompInfoMsg::setNotifyLevel ( DtNotifyLevelType level ) [virtual]

Set notify level.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::notifyLevel.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setReliableIpAddress ( const MAKRti::DtInetAddr & ipAddr ) [virtual]

Set rtiexec's reliable forwarder IP address.

References netAssistantRtiexecCompInfoMsg(), DtNetAssistantRtiexecCompInfoMsg::reliableIpAddress, and setAddressFamily().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setTcpPort ( int port ) [virtual]

Set rtiexec's forwarder TCP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::tcpPort.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setUdpPort ( int port ) [virtual]

Set rtiexec's forwarder UDP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::udpPort.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setWebSpyIpAddress ( const MAKRti::DtInetAddr & ipAddr ) [virtual]

Set the web spy host IP address.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::webSpyIpAddress.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setWebSpyPort ( int port ) [virtual]

Set the web spy port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::webSpyPort.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

int DtAssistantRtiexecCompInfoMsg::tcpPort ( ) const [virtual]

Get rtiexec's forwarder TCP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::tcpPort.

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

int DtAssistantRtiexecCompInfoMsg::udpPort ( ) const [virtual]

Get rtiexec's forwarder UDP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::udpPort.

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

DtInetAddr DtAssistantRtiexecCompInfoMsg::webSpyIpAddress ( ) const [virtual]

Get the web spy host IP address.

References netAssistantRtiexecCompInfoMsg().

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

int DtAssistantRtiexecCompInfoMsg::webSpyPort ( ) const [virtual]

Get the web spy port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::webSpyPort.

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

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