DtRtiAssistantExecClient Class Reference

The client connection to the RTI Assistant for the rtiexec. More...

Inheritance diagram for DtRtiAssistantExecClient:

Collaboration diagram for DtRtiAssistantExecClient:

List of all members.

Public Member Functions
	DtRtiAssistantExecClient (int port=0)
	Constructor.
virtual	~DtRtiAssistantExecClient ()
	Destructor.
virtual void	updateForwarderInfo (const MAKRti::DtInetAddr &reliableIpAddr, const MAKRti::DtInetAddr &bestEffortIpAddr, int udpPort, int tcpPort, bool fullCompliance, int forwarderPort, const MAKRti::DtInetAddr &additionalForwarder)
	Updates the forwarder address and port to be sent to the Assistant.
virtual void	updateWebSpyInfo (const MAKRti::DtInetAddr &ipAddr, int port)
	Updates the information needed for the Assistant to open the web spy page, namely the host IP address and port number.
virtual void	updateLogFile (const MAKRti::DtFilename &file)
	Updates the log file name used by this rtiexec.
virtual void	updateIsConnected (bool connected)
	Updates the flag indicating that the rtiexec is conencted to the forwarder.
virtual void	updateLicenseServer (const MAKRti::DtString &server)
	Updates the license server used by this rtiexec.
virtual void	sendClientInfo ()
	Send forwarder address and port, web spy info, log file info, and license server to the assistant.
virtual void	sendFederationStateMsg (const DtAssistantFederationInfo &fedexInfo, bool isRemoval)
	Sends a message to update the assistant with the latest info for an entire federation.
virtual void	sendNoFederationMsg ()
	Sends a message to tell the assistant that this rtiexec currently has no federations.
virtual void	sendExecStateMsg (const std::list< DtAssistantFederationInfo > &execInfo)
	Sends a message to update the assistant with the latest info for an entire Exec (all fedex's).
virtual void	sendFederateUpdateMsg (const DtAssistantFederateInfo &fedInfo, const MAKRti::DtString &fedexName, bool isRemoval)
	Sends a message to update the assistant with the latest info for a single federate.
virtual void	sendFederationTimeStateMsg (const DtAssistantFederationInfo &fedexInfo)
	Send all time state information for the given federation.
virtual void	sendSyncPtUpdateMsg (const MAKRti::DtString &syncPtName, const DtPendingAchievedPair &pendAchieve, const MAKRti::DtString &fedexName, bool isRemoval)
	Sends a message to update the assistant with the latest sync point info for a federation.
virtual void	sendRidParamsMsg (const MAKRti::DtString &params, const MAKRti::DtFilename &filename)
	Send the RID parameters.
virtual void	sendLogMsg (const DtLogEntryList &log, unsigned maxSize, const MAKRti::DtInetAddr &destAddr=MAKRti::DtInetAddr(), int destId=-1)
	Send the log. Can optionally specify the destination assistant.
Protected Attributes
MAKRti::DtInetAddr	myWebSpyAddr
	The host address for the web spy.
int	myWebSpyPort
	The port for the web spy.
int	myIsConnected
	Indicates if the rtiexec is connected to the forwarder.
MAKRti::DtFilename	myLogFile
	The name and full path of the log file.
MAKRti::DtString	myLicServer
	The license server used by this LRC.

---

Detailed Description

The client connection to the RTI Assistant for the rtiexec.

DtRtiAssistantExecClient manages the client connection of the rtiexec to the RTI Assistant. Provides routines to create and send messages to the Assistant.

---

Constructor & Destructor Documentation

DtRtiAssistantExecClient::DtRtiAssistantExecClient

(

int

port = 0

)

Constructor.

DtRtiAssistantExecClient::~DtRtiAssistantExecClient

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtRtiAssistantExecClient::sendClientInfo

(

)

[virtual]

Send forwarder address and port, web spy info, log file info, and license server to the assistant.

Reimplemented from DtRtiAssistantForwarderClient.

References DtAssistantRtiexecCompInfoMsgKind, DtRtiAssistantClient::msgFactory(), DtRtiAssistantForwarderClient::myAdditionalForwarder, DtRtiAssistantForwarderClient::myBestEffortAddr, DtRtiAssistantForwarderClient::myForwarderPort, DtRtiAssistantForwarderClient::myFullCompliance, DtRtiAssistantForwarderClient::myHostName, myIsConnected, myLicServer, myLogFile, DtRtiAssistantForwarderClient::myReliableAddr, DtRtiAssistantForwarderClient::myTcpPort, DtRtiAssistantForwarderClient::myUdpPort, myWebSpyAddr, myWebSpyPort, DtRtiAssistantClient::sendMsg(), DtAssistantRtiexecCompInfoMsg::setAdditionalForwarderConnection(), DtAssistantRtiexecCompInfoMsg::setBestEffortIpAddress(), DtAssistantRtiexecCompInfoMsg::setForwarderPort(), DtAssistantRtiexecCompInfoMsg::setFullCompliance(), DtAssistantRtiexecCompInfoMsg::setHostName(), DtAssistantRtiexecCompInfoMsg::setIsConnected(), DtAssistantRtiexecCompInfoMsg::setLicServer(), DtAssistantRtiexecCompInfoMsg::setLogFilename(), DtAssistantRtiexecCompInfoMsg::setNotifyLevel(), DtAssistantRtiexecCompInfoMsg::setReliableIpAddress(), DtAssistantRtiexecCompInfoMsg::setTcpPort(), DtAssistantRtiexecCompInfoMsg::setUdpPort(), DtAssistantRtiexecCompInfoMsg::setWebSpyIpAddress(), and DtAssistantRtiexecCompInfoMsg::setWebSpyPort().

void DtRtiAssistantExecClient::sendExecStateMsg

(

const std::list< DtAssistantFederationInfo > &

execInfo

)

[virtual]

Sends a message to update the assistant with the latest info for an entire Exec (all fedex's).

References DtAssistantExecStateMsgKind, DtAssistantFederateInfo::federateHostAddr(), DtAssistantFederateInfo::federateHostName(), DtAssistantFederateInfo::federateName(), DtAssistantFederationInfo::federates(), DtAssistantFederateInfo::federateType(), DtAssistantFederationInfo::federationHandle(), DtAssistantFederationInfo::federationName(), DtAssistantFederateInfo::hlaVersion(), DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), and DtAssistantExecStateMsg::setAllData().

void DtRtiAssistantExecClient::sendFederateUpdateMsg	(	const DtAssistantFederateInfo &	fedInfo,
		const MAKRti::DtString &	fedexName,
		bool	isRemoval
	)		[virtual]

Sends a message to update the assistant with the latest info for a single federate.

The given federate is to be removed if the isRemoval flag is set. Does not send time state information.

References DtAssistantFederateInfo::connId(), DtAssistantFederateInfo::continuousTest(), DtAssistantFederateStateMsgKind, DtAssistantFederateInfo::federateHandle(), DtAssistantFederateInfo::federateHostAddr(), DtAssistantFederateInfo::federateHostName(), DtAssistantFederateInfo::federateName(), DtAssistantFederateInfo::federateType(), DtAssistantFederateInfo::hlaVersion(), DtAssistantFederateInfo::isDisconnected(), DtAssistantFederateInfo::isReconnecting(), DtRtiAssistantClient::msgFactory(), DtAssistantFederateInfo::numInitiatedTests(), DtAssistantFederateInfo::numTestReports(), DtRtiAssistantClient::sendMsg(), DtAssistantFederateStateMsg::setConnectionId(), DtAssistantFederateStateMsg::setFederateHandle(), DtAssistantFederateStateMsg::setFederateHostIp(), DtAssistantFederateStateMsg::setFederateHostName(), DtAssistantFederateStateMsg::setFederateName(), DtAssistantFederateStateMsg::setFederateType(), DtAssistantFederateStateMsg::setFederationName(), DtAssistantFederateStateMsg::setHlaVersion(), DtAssistantFederateStateMsg::setIsContinuousTest(), DtAssistantFederateStateMsg::setIsDisconnected(), DtAssistantFederateStateMsg::setIsReconnecting(), DtAssistantFederateStateMsg::setIsRemoval(), DtAssistantFederateStateMsg::setIsTestEnabled(), DtAssistantFederateStateMsg::setIsTestInProgress(), DtAssistantFederateStateMsg::setNumInitiatedTests(), DtAssistantFederateStateMsg::setNumTestReports(), DtAssistantFederateStateMsg::setWebServerIp(), DtAssistantFederateStateMsg::setWebServerPort(), DtAssistantFederateInfo::testEnabled(), DtAssistantFederateInfo::testInProgress(), DtAssistantFederateInfo::webSpyAddr(), and DtAssistantFederateInfo::webSpyHttpPort().

void DtRtiAssistantExecClient::sendFederationStateMsg	(	const DtAssistantFederationInfo &	fedexInfo,
		bool	isRemoval
	)		[virtual]

Sends a message to update the assistant with the latest info for an entire federation.

The given federation is to be removed if the isRemoval flag is set.

References DtAssistantFederationStateMsgKind, DtAssistantFederationInfo::federates(), DtAssistantFederationInfo::federationHandle(), DtAssistantFederationInfo::federationName(), DtAssistantFederationInfo::fomModules(), DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), DtAssistantFederationStateMsg::setFederateStates(), DtAssistantFederationStateMsg::setFederationHandle(), DtAssistantFederationStateMsg::setFederationName(), DtAssistantFederationStateMsg::setFedFileName(), DtAssistantFederationStateMsg::setFomModules(), DtAssistantFederationStateMsg::setIsRemoval(), DtAssistantFederationStateMsg::setIsTestEnabled(), DtAssistantFederationStateMsg::setNoFederations(), and DtAssistantFederationInfo::testingEnabled().

void DtRtiAssistantExecClient::sendFederationTimeStateMsg

(

const DtAssistantFederationInfo &

fedexInfo

)

[virtual]

Send all time state information for the given federation.

References DtAssistantTimeStateMsgKind, DtAssistantFederationInfo::federates(), DtAssistantFederationInfo::federationName(), DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), DtAssistantTimeStateMsg::setFederateTimeStates(), and DtAssistantTimeStateMsg::setFederationName().

void DtRtiAssistantExecClient::sendLogMsg	(	const DtLogEntryList &	log,
		unsigned	maxSize,
		const MAKRti::DtInetAddr &	destAddr = MAKRti::DtInetAddr(),
		int	destId = -1
	)		[virtual]

Send the log. Can optionally specify the destination assistant.

References DtAssistantLogMsgKind, DtMsgSocket::maxSendMsgSize(), DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::mySocket, DtRtiAssistantClient::sendMsg(), DtAssistantMsg::setDestAddr(), DtAssistantMsg::setDestId(), and DtAssistantLogMsg::setLog().

void DtRtiAssistantExecClient::sendNoFederationMsg

(

)

[virtual]

Sends a message to tell the assistant that this rtiexec currently has no federations.

References DtAssistantFederationStateMsgKind, DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), and DtAssistantFederationStateMsg::setNoFederations().

void DtRtiAssistantExecClient::sendRidParamsMsg	(	const MAKRti::DtString &	params,
		const MAKRti::DtFilename &	filename
	)		[virtual]

Send the RID parameters.

References DtAssistantRidParamsMsgKind, DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), DtAssistantRidParamsMsg::setIsRequest(), DtAssistantRidParamsMsg::setRidFilename(), and DtAssistantRidParamsMsg::setRidParams().

void DtRtiAssistantExecClient::sendSyncPtUpdateMsg	(	const MAKRti::DtString &	syncPtName,
		const DtPendingAchievedPair &	pendAchieve,
		const MAKRti::DtString &	fedexName,
		bool	isRemoval
	)		[virtual]

Sends a message to update the assistant with the latest sync point info for a federation.

The given sync point is to be removed if the isRemoval flag is set.

References DtAssistantSyncPtUpdateMsgKind, DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), DtAssistantSyncPtUpdateMsg::setFederationName(), DtAssistantSyncPtUpdateMsg::setIsRemoval(), DtAssistantSyncPtUpdateMsg::setPendingAndAchieved(), and DtAssistantSyncPtUpdateMsg::setSyncPtName().

void DtRtiAssistantExecClient::updateForwarderInfo	(	const MAKRti::DtInetAddr &	reliableIpAddr,
		const MAKRti::DtInetAddr &	bestEffortIpAddr,
		int	udpPort,
		int	tcpPort,
		bool	fullCompliance,
		int	forwarderPort,
		const MAKRti::DtInetAddr &	additionalForwarder
	)		[virtual]

Updates the forwarder address and port to be sent to the Assistant.

Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

Reimplemented from DtRtiAssistantForwarderClient.

void DtRtiAssistantExecClient::updateIsConnected

(

bool

connected

)

[virtual]

Updates the flag indicating that the rtiexec is conencted to the forwarder.

Note that this method does not send the message to the assistant, just stores the value to be sent when sendLrcInfo is called.

References myIsConnected.

void DtRtiAssistantExecClient::updateLicenseServer

(

const MAKRti::DtString &

server

)

[virtual]

Updates the license server used by this rtiexec.

Used by the Assistant to help other components locate a license. Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myLicServer.

Referenced by DtFedExec::init().

void DtRtiAssistantExecClient::updateLogFile

(

const MAKRti::DtFilename &

file

)

[virtual]

Updates the log file name used by this rtiexec.

This is sent to the Assistant so that it may display the log to interested users. Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myLogFile, and NULL.

void DtRtiAssistantExecClient::updateWebSpyInfo	(	const MAKRti::DtInetAddr &	ipAddr,
		int	port
	)		[virtual]

Updates the information needed for the Assistant to open the web spy page, namely the host IP address and port number.

Note that this method does not send the message to the assistant, just stores the info to be sent when sendClientInfo is called.

References myWebSpyAddr, and myWebSpyPort.

---

Member Data Documentation

int DtRtiAssistantExecClient::myIsConnected [protected]

Indicates if the rtiexec is connected to the forwarder.

Referenced by sendClientInfo(), and updateIsConnected().

MAKRti::DtString DtRtiAssistantExecClient::myLicServer [protected]

The license server used by this LRC.

Referenced by sendClientInfo(), and updateLicenseServer().

MAKRti::DtFilename DtRtiAssistantExecClient::myLogFile [protected]

The name and full path of the log file.

Referenced by sendClientInfo(), and updateLogFile().

MAKRti::DtInetAddr DtRtiAssistantExecClient::myWebSpyAddr [protected]

The host address for the web spy.

Referenced by sendClientInfo(), and updateWebSpyInfo().

int DtRtiAssistantExecClient::myWebSpyPort [protected]

The port for the web spy.

Referenced by sendClientInfo(), and updateWebSpyInfo().

---

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

• rtiAssistantExecClient.h
• rtiAssistantExecClient.cxx