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

Inheritance diagram for DtAssistantRtiForwarderCompInfoMsg:

Collaboration diagram for DtAssistantRtiForwarderCompInfoMsg:

List of all members.

Public Member Functions
	DtAssistantRtiForwarderCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantRtiForwarderCompInfoMsg (const DtNetAssistantRtiForwarderCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantRtiForwarderCompInfoMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setReliableIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set RTI Forwarder's reliable forwarder IP address.
virtual MAKRti::DtInetAddr	reliableIpAddress () const
	Get RTI Forwarder's reliable forwarder IP address.
virtual void	setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set RTI Forwarder's best effort IP address.
virtual MAKRti::DtInetAddr	bestEffortIpAddress () const
	Get RTI Forwarder's best effort IP address.
virtual void	setUdpPort (int port)
	Set RTI Forwarder's UDP port number.
virtual int	udpPort () const
	Get RTI Forwarder's UDP port number.
virtual void	setTcpPort (int port)
	Set RTI Forwarder's TCP port number.
virtual int	tcpPort () const
	Get RTI Forwarder's TCP port number.
virtual void	setHostName (const MAKRti::DtString &name)
	Set RTI Forwarder host name.
virtual MAKRti::DtString	hostName () const
	Get RTI Forwarder host name.
virtual void	setFullCompliance (bool val)
	Set the flag indicating if RTI Forwarder is running with full compliance.
virtual bool	fullCompliance () const
	Get the flag indicating if RTI Forwarder is running with full compliance.
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 bool	execConfirmed () const
	Get exec connection status.
virtual void	setExecConfirmed (bool isConnected)
	Set status of exec connection.
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, DtAssistantRtiForwarderCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantRtiForwarderCompInfoCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantRtiForwarderCompInfoMsg *	netAssistantRtiForwarderCompInfoMsg ()
	The network representation for the RTI Forwarder component information.
virtual const DtNetAssistantRtiForwarderCompInfoMsg *	netAssistantRtiForwarderCompInfoMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantRtiForwarderCompInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setHostNameSize (unsigned long size)
	Set/Get RTI Forwarder host name size.
virtual unsigned long	hostNameSize () const
virtual const char *	hostNamePtr () const
	Return pointer to RTI Forwarder host name location in message.
virtual char *	hostNamePtr ()

Detailed Description

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

Constructor & Destructor Documentation

DtAssistantRtiForwarderCompInfoMsg::DtAssistantRtiForwarderCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantRtiForwarderCompInfoMsg::DtAssistantRtiForwarderCompInfoMsg	(	const DtNetAssistantRtiForwarderCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantRtiForwarderCompInfoMsg::~DtAssistantRtiForwarderCompInfoMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantRtiForwarderCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiForwarderCompInfoCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantRtiForwarderCompInfoMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

DtInetAddr DtAssistantRtiForwarderCompInfoMsg::additionalForwarderConnection ( ) const [virtual]

Get the optional additional forwarder to connect to.

References netAssistantRtiForwarderCompInfoMsg().

Referenced by printData().

DtInetAddr DtAssistantRtiForwarderCompInfoMsg::bestEffortIpAddress ( ) const [virtual]

Get RTI Forwarder's best effort IP address.

References netAssistantRtiForwarderCompInfoMsg().

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

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

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

Implements DtAssistantMsg.

References DtAssistantRtiForwarderCompInfoMsg(), and netAssistantRtiForwarderCompInfoMsg().

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

Creators.

References DtAssistantRtiForwarderCompInfoMsg().

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

References DtAssistantRtiForwarderCompInfoMsg().

bool DtAssistantRtiForwarderCompInfoMsg::execConfirmed ( ) const [virtual]

Get exec connection status.

References DtNetAssistantRtiForwarderCompInfoMsg::execConfirmed, and netAssistantRtiForwarderCompInfoMsg().

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

int DtAssistantRtiForwarderCompInfoMsg::forwarderPort ( ) const [virtual]

Get the forwarder port.

References DtNetAssistantRtiForwarderCompInfoMsg::forwarderPort, and netAssistantRtiForwarderCompInfoMsg().

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

bool DtAssistantRtiForwarderCompInfoMsg::fullCompliance ( ) const [virtual]

Get the flag indicating if RTI Forwarder is running with full compliance.

References DtNetAssistantRtiForwarderCompInfoMsg::fullCompliance, and netAssistantRtiForwarderCompInfoMsg().

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

DtString DtAssistantRtiForwarderCompInfoMsg::hostName ( ) const [virtual]

Get RTI Forwarder host name.

References hostNamePtr(), and hostNameSize().

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

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

Return pointer to RTI Forwarder host name location in message.

References netAssistantRtiForwarderCompInfoMsg().

Referenced by hostName(), and setHostName().

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

References netAssistantRtiForwarderCompInfoMsg().

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

References DtNetAssistantRtiForwarderCompInfoMsg::hostNameSize, and netAssistantRtiForwarderCompInfoMsg().

Referenced by hostName(), and setHostName().

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

Returns the kind of a DtAssistantRtiForwarderCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantRtiForwarderCompInfoMsgKind.

Referenced by DtAssistantRtiForwarderCompInfoMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantRtiForwarderCompInfoMsg().

DtNetAssistantRtiForwarderCompInfoMsg * DtAssistantRtiForwarderCompInfoMsg::netAssistantRtiForwarderCompInfoMsg ( ) [protected, virtual]

The network representation for the RTI Forwarder component information.

Referenced by additionalForwarderConnection(), bestEffortIpAddress(), clone(), execConfirmed(), forwarderPort(), fullCompliance(), hostNamePtr(), hostNameSize(), reliableIpAddress(), setAdditionalForwarderConnection(), setBestEffortIpAddress(), setExecConfirmed(), setForwarderPort(), setFullCompliance(), setHostNameSize(), setReliableIpAddress(), setTcpPort(), setUdpPort(), tcpPort(), and udpPort().

const DtNetAssistantRtiForwarderCompInfoMsg * DtAssistantRtiForwarderCompInfoMsg::netAssistantRtiForwarderCompInfoMsg ( ) const [protected, virtual]

void DtAssistantRtiForwarderCompInfoMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References additionalForwarderConnection(), bestEffortIpAddress(), execConfirmed(), forwarderPort(), fullCompliance(), hostName(), reliableIpAddress(), tcpPort(), and udpPort().

DtInetAddr DtAssistantRtiForwarderCompInfoMsg::reliableIpAddress ( ) const [virtual]

Get RTI Forwarder's reliable forwarder IP address.

References netAssistantRtiForwarderCompInfoMsg().

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

void DtAssistantRtiForwarderCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiForwarderCompInfoCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantRtiForwarderCompInfoMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantComponentMgr::~DtAssistantComponentMgr().

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

Set the optional additional forwarder to connect to.

References DtNetAssistantRtiForwarderCompInfoMsg::additionalForwarderAddress, and netAssistantRtiForwarderCompInfoMsg().

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set RTI Forwarder's best effort IP address.

References DtNetAssistantRtiForwarderCompInfoMsg::addressFamily, DtNetAssistantRtiForwarderCompInfoMsg::bestEffortIpAddress, and netAssistantRtiForwarderCompInfoMsg().

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

void DtAssistantRtiForwarderCompInfoMsg::setExecConfirmed ( bool isConnected ) [virtual]

Set status of exec connection.

References DtNetAssistantRtiForwarderCompInfoMsg::execConfirmed, and netAssistantRtiForwarderCompInfoMsg().

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set the forwarder port.

References DtNetAssistantRtiForwarderCompInfoMsg::forwarderPort, and netAssistantRtiForwarderCompInfoMsg().

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set the flag indicating if RTI Forwarder is running with full compliance.

References DtNetAssistantRtiForwarderCompInfoMsg::fullCompliance, and netAssistantRtiForwarderCompInfoMsg().

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set RTI Forwarder host name.

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

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set/Get RTI Forwarder host name size.

References DtNetAssistantRtiForwarderCompInfoMsg::hostNameSize, and netAssistantRtiForwarderCompInfoMsg().

Referenced by setHostName().

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

Set RTI Forwarder's reliable forwarder IP address.

References DtNetAssistantRtiForwarderCompInfoMsg::addressFamily, netAssistantRtiForwarderCompInfoMsg(), and DtNetAssistantRtiForwarderCompInfoMsg::reliableIpAddress.

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set RTI Forwarder's TCP port number.

References netAssistantRtiForwarderCompInfoMsg(), and DtNetAssistantRtiForwarderCompInfoMsg::tcpPort.

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

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

Set RTI Forwarder's UDP port number.

References netAssistantRtiForwarderCompInfoMsg(), and DtNetAssistantRtiForwarderCompInfoMsg::udpPort.

Referenced by DtRtiAssistantForwarderClient::sendClientInfo().

int DtAssistantRtiForwarderCompInfoMsg::tcpPort ( ) const [virtual]

Get RTI Forwarder's TCP port number.

References netAssistantRtiForwarderCompInfoMsg(), and DtNetAssistantRtiForwarderCompInfoMsg::tcpPort.

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

int DtAssistantRtiForwarderCompInfoMsg::udpPort ( ) const [virtual]

Get RTI Forwarder's UDP port number.

References netAssistantRtiForwarderCompInfoMsg(), and DtNetAssistantRtiForwarderCompInfoMsg::udpPort.

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

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