Manages the client connection to the RTI Assistant. More...

Inheritance diagram for DtRtiAssistantClient:

Collaboration diagram for DtRtiAssistantClient:

Public Member Functions
	DtRtiAssistantClient (DtAssistantComponentType type, int port=DtASSISTANT_DEFAULT_PORT)
	Constructor.
virtual	~DtRtiAssistantClient ()
	Destructor.
virtual bool	tick (unsigned int timeout=0)
	Do the actual message processing.
virtual bool	isConnected ()
	Returns true if the socket is connected.
virtual bool	isDisabled ()
	Returns true if the socket is disabled.
virtual void	addMsgCallback (DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
	Message Callbacks These callback functions operate on all of the connections.
virtual void	removeMsgCallback (DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
virtual void	addWildcardMsgCallback (DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
virtual void	removeWildcardMsgCallback (DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr)
virtual void	addDisconnectCallback (DtAssistantDisconnectCb cb, void *usr)
	These functions add callbacks for notification of a socket disconnect.
virtual void	removeDisconnectCallback (DtAssistantDisconnectCb cb, void *usr)
virtual bool	sendLRCConnQueryMsg (bool error, MAKRti::DtInetAddr &relIpAddr, MAKRti::DtInetAddr &beIpAddr, MAKRti::DtInetAddr &interfaceAddr, int &udpPort, int &tcpPort, bool &useRtiexec, bool &forceFullCompliance, int &forwarderPort)
	Send a message querying for the connection parameters.
virtual bool	sendForwardingComponentConnQueryMsg (bool error, MAKRti::DtInetAddr &relIpAddr, MAKRti::DtInetAddr &beIpAddr, MAKRti::DtInetAddr &interfaceAddr, int &udpPort, int &tcpPort, bool &forceFullCompliance, int &forwarderPort, MAKRti::DtInetAddr &forwardrToConnectTo)
	Send a message querying for the rtiexec connection parameters.
virtual void	sendLatencyTestMsg (const DtAssistantLatencyReportMsg &msg)
	Send a message to the assistant with latency test measurements.
virtual void	sendLatencyTestStatusMsg (const DtAssistantTestMgrStatusMsg &msg)
	Send an updated latency test status message to the assistant.
virtual bool	getNewLicenseServerFromAssistant (bool allowUnlicensed, bool &runUnlicensed, MAKRti::DtString &serverName, const MAKRti::DtString &featToCheck)
	Send a message to the assistant to query the user for an alternate license server.
virtual void	sendNotifyMsg (const MAKRti::DtString &text, DtNotifyLevelType notifyLevel)
	Send a message to display a pop up notification above the tray icon.
virtual void	sendSignalTickedMsg ()
	Send a signal ticked message to the assistant.
virtual void	sendDialogBoxMsg (const MAKRti::DtString &text, const MAKRti::DtString &advancedText)
	Send a message to display a dialog notification.
virtual void	sendClose ()
	Send connection closed message to Assistant.
virtual void	setMsgFactory (DtAssistantMessageFactory *fact)
	Get/Set the message factory.
virtual DtAssistantMessageFactory *	msgFactory () const
virtual void	shutDownConnection ()
	AssistantClientOwner should call this function when it processes an assistantExitMsg.
virtual MAKRti::DtString	getProcessName () const
	get the process name
virtual int	getPID () const
	get the PID
virtual MAKRti::DtString	getCommandArgs () const
	get the command args
bool	testConnectionStatus ()
	test the connection
Protected Member Functions
virtual bool	initialize ()
	Attempts to connect to the RTI Assistant.
virtual DtAssistantConnectionStatus	connectToAssistant ()
	Attempt to open a connection and handshake with the Assistant.
virtual DtAssistantConnectionStatus	makeSingleConnectionAttempt ()
virtual bool	startAssistant ()
	Attempt to start a new Assistant.
virtual bool	readAndProcess (MAKRti::DtTime maxTime)
	Read and process any messages on the socket for up to the maxTime.
virtual bool	sendMsg (const DtAssistantMsg &msg)
	Send a message to the RTI Assistant.
virtual DtAssistantMsg *	sendMsgAndWait (const DtAssistantMsg &msg, DtAssistantMsgKind respKind, unsigned int waitSecs=0)
	Send a message to the RTI Assistant and wait for response of the specified kind.
virtual DtAssistantConnectionStatus	sendConnectMsg ()
	Send basic component information to the Assistant for a new connection.
virtual void	processRespMsg (const DtAssistantMsg &respMsg)
virtual void	processNtfyLvlUpdateMsg (const DtAssistantNtfyLvlUpdateMsg &updateMsg)
virtual void	processAssistantExitMsg (const DtAssistantExitMsg &inter)
virtual void	processDisconnect ()
	Process Assistant socket disconnect.
virtual std::auto_ptr < DtAssistantMsg >	netRead (int *retCode) const
	Attempt to read a new message from the socket.
virtual bool	sendLicQueryMsg (bool allowUnlicensed, bool &runUnlicensed, MAKRti::DtString &licServer)
	Send a message querying for the license server.
virtual void	sendClientInfo ()
	intended to be over-ridden by subclasses.
Static Protected Member Functions
static void	processRespMsg (const DtAssistantMsg &respMsg, void *usr)
	Response message callback.
static void	processNtfyLvlUpdateMsg (const DtAssistantNtfyLvlUpdateMsg &updateMsg, void *usr)
	Notify level update message callback.
static void	processAssistantExitMsg (const DtAssistantExitMsg &inter, void *usr)
	Process the assistant exit message. The assistant is commanding us to exit.
Protected Attributes
bool	myAssistantDisabled
	Set to true if the Assistant is disabled.
MAKRti::DtInetAddr	myAssistantAddr
	The IP address of the Assistant.
unsigned int	myAssistantPort
	The port on which the RTI Assistant listens for connections.
DtTcpMsgSocket *	mySocket
	The socket to the RTI Assistant.
bool	myCreateIfConnectFails
	Indicates whether an Assistant should be created if a connection cannot be established.
DtAssistantConnectionStatus	myConnStatus
	The current connection status.
bool	myInitializingConnection
	Is connection being initialized.
MAKRti::DtU32	mySockOpts
	The socket options to be used when connecting to the Assistant.
DtAssistantMessageFactory *	myMessageFactory
	The message factory.
DtAssistantDfltMsgFactory	myDefaultMessageFactory
	Default message factory.
DtAssistantComponentType	myComponentType
	The component type. (LRC, rtiexec, etc.)
MAKRti::DtClock	myClock
	Clock for timeouts.
MAKRti::DtTime	myConnTestInterval
	Interval at which connection should be tested.
MAKRti::DtTime	myTimeToTestConnection
	Next time to test connection.
DtAssistantMsgCbMgr	myMsgCbMgr
	Message callback manager.
std::auto_ptr< DtAssistantMsg >	myRespMsg
	The last response message to be received.
std::list < DtAssistantDisconnectCbInfo * >	myDisconnectCallbacks
	Lists of pointers to socket disconnect callbacks.
MAKRti::DtMutex *	mySocketMutex
	locks access to the socket connection.
bool	myShouldShutdown
	should be set when assistant exit msg has been received.
int	myNumFailedAssistantConnects
	How many assistant restarts have we attempted.
int	myNumSuccessfulAssistantConnects
	How many assistant reconnects occurred.
int	myPID
	the Process ID ( PID )
MAKRti::DtString	myProcessName
	the Process Name
MAKRti::DtString	myCommandArgs
	the command line arguments
Static Protected Attributes
static const int	theMaxNumberOfAssistantConnectAttempts = 10
	either starting up or reconnecting, how many assistant restarts do we tolerate before giving up.
static const MAKRti::DtInetAddr	theFirstHostInetAddr = DtDefaultInterfaceAddr()
	The first InetAddr when the federate was launched.
Private Member Functions
	DtRtiAssistantClient (DtRtiAssistantClient const &)
	Copy constructor not implemented.
DtRtiAssistantClient &	operator= (DtRtiAssistantClient const &)
	Assignment operator not implemented.

Detailed Description

Manages the client connection to the RTI Assistant.

DtRtiAssistantClient manages the connection to the RTI Assistant. It also provides methods for packaging and sending common messages to the RTI Assistant.

Constructor & Destructor Documentation

DtRtiAssistantClient::DtRtiAssistantClient	(	DtAssistantComponentType	type,
		int	port = `DtASSISTANT_DEFAULT_PORT`
	)

Constructor.

References DtAssistantExitMsg::addCallback(), DtAssistantNtfyLvlUpdateMsg::addCallback(), myAssistantAddr, myCommandArgs, myPID, myProcessName, mySocketMutex, NULL, processAssistantExitMsg(), processNtfyLvlUpdateMsg(), and DtAssistantPopupHelper::setCreatorFunction().

DtRtiAssistantClient::~DtRtiAssistantClient ( ) [virtual]

Destructor.

References mySocket, and mySocketMutex.

DtRtiAssistantClient::DtRtiAssistantClient ( DtRtiAssistantClient const & ) [private]

Copy constructor not implemented.

Member Function Documentation

void DtRtiAssistantClient::addDisconnectCallback	(	DtAssistantDisconnectCb	cb,
		void *	usr
	)		`[virtual]`

These functions add callbacks for notification of a socket disconnect.

References myDisconnectCallbacks.

void DtRtiAssistantClient::addMsgCallback	(	DtAssistantMsgKind	msgKind,
		DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		`[virtual]`

Message Callbacks These callback functions operate on all of the connections.

References myMsgCbMgr.

void DtRtiAssistantClient::addWildcardMsgCallback	(	DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		`[virtual]`

References myMsgCbMgr.

DtAssistantConnectionStatus DtRtiAssistantClient::connectToAssistant ( ) [protected, virtual]

Attempt to open a connection and handshake with the Assistant.

Returns the connection status. Does not block, so

References DtAssistantConnected, DtAssistantConnectFailed, DtAssistantNoResponse, makeSingleConnectionAttempt(), myCreateIfConnectFails, myNumFailedAssistantConnects, startAssistant(), and theMaxNumberOfAssistantConnectAttempts.

Referenced by initialize().

MAKRti::DtString DtRtiAssistantClient::getCommandArgs ( ) const [virtual]

get the command args

References myCommandArgs.

bool DtRtiAssistantClient::getNewLicenseServerFromAssistant	(	bool	allowUnlicensed,
		bool &	runUnlicensed,
		MAKRti::DtString &	serverName,
		const MAKRti::DtString &	featToCheck
	)		`[virtual]`

Send a message to the assistant to query the user for an alternate license server.

Returns true unless user cancels dialog.

References lm, and sendLicQueryMsg().

Referenced by DtFedExec::init(), and initControl().

int DtRtiAssistantClient::getPID ( ) const [virtual]

get the PID

References myPID.

MAKRti::DtString DtRtiAssistantClient::getProcessName ( ) const [virtual]

get the process name

References myProcessName.

bool DtRtiAssistantClient::initialize ( ) [protected, virtual]

Attempts to connect to the RTI Assistant.

Will create one if none is present.

References connectToAssistant(), DtAssistantConnected, DtAssistantConnectFailed, DtAssistantConnectRejected, DtAssistantNoResponse, DtAssistantWrongDisplay, isDisabled(), myAssistantDisabled, myInitializingConnection, myNumSuccessfulAssistantConnects, myShouldShutdown, and sendClientInfo().

Referenced by DtRtiAssistantForwarderClient::DtRtiAssistantForwarderClient(), DtRtiAssistantLrcClient::DtRtiAssistantLrcClient(), DtRtiAssistantShmExecClient::DtRtiAssistantShmExecClient(), DtRtiAssistantToAssistantClient::DtRtiAssistantToAssistantClient(), DtRtiAssistantWwwClient::DtRtiAssistantWwwClient(), readAndProcess(), sendMsg(), and sendMsgAndWait().

bool DtRtiAssistantClient::isConnected ( ) [virtual]

Returns true if the socket is connected.

References DtTcpMsgSocket::isConnected(), and mySocket.

Referenced by DtRtiAssistant::connectToAssistant(), initControl(), and DtRtiAssistant::sendInteractiveCommandToConnectedAssistant().

bool DtRtiAssistantClient::isDisabled ( ) [virtual]

Returns true if the socket is disabled.

References myAssistantDisabled, myNumFailedAssistantConnects, and theMaxNumberOfAssistantConnectAttempts.

Referenced by initialize(), and DtRtiAssistant::sendInteractiveCommandToConnectedAssistant().

DtAssistantConnectionStatus DtRtiAssistantClient::makeSingleConnectionAttempt ( ) [protected, virtual]

References DtAssistantConnectFailed, DtTcpMsgSocket::isConnected(), myAssistantAddr, myAssistantPort, myConnStatus, mySocket, mySocketMutex, mySockOpts, DtTcpMsgSocket::openClientSocket(), sendConnectMsg(), and DtTcpMsgSocket::setNonBlocking().

Referenced by connectToAssistant().

DtAssistantMessageFactory * DtRtiAssistantClient::msgFactory ( ) const [virtual]

References myMessageFactory.

std::auto_ptr< DtAssistantMsg > DtRtiAssistantClient::netRead ( int * retCode ) const [protected, virtual]

DtRtiAssistantClient& DtRtiAssistantClient::operator= ( DtRtiAssistantClient const & ) [private]

Assignment operator not implemented.

void DtRtiAssistantClient::processAssistantExitMsg	(	const DtAssistantExitMsg &	inter,
		void *	usr
	)		`[static, protected]`

Process the assistant exit message. The assistant is commanding us to exit.

Referenced by DtRtiAssistantClient().

void DtRtiAssistantClient::processAssistantExitMsg ( const DtAssistantExitMsg & inter ) [protected, virtual]

References shutDownConnection().

void DtRtiAssistantClient::processDisconnect ( ) [protected, virtual]

Process Assistant socket disconnect.

References DtAssistantDisconnectCbInfo::myCb, myDisconnectCallbacks, and DtAssistantDisconnectCbInfo::myUsr.

Referenced by testConnectionStatus(), and tick().

void DtRtiAssistantClient::processNtfyLvlUpdateMsg	(	const DtAssistantNtfyLvlUpdateMsg &	updateMsg,
		void *	usr
	)		`[static, protected]`

Notify level update message callback.

Referenced by DtRtiAssistantClient().

void DtRtiAssistantClient::processNtfyLvlUpdateMsg ( const DtAssistantNtfyLvlUpdateMsg & updateMsg ) [protected, virtual]

References DtAssistantNtfyLvlUpdateMsg::notifyLevel().

void DtRtiAssistantClient::processRespMsg	(	const DtAssistantMsg &	respMsg,
		void *	usr
	)		`[static, protected]`

Response message callback.

Referenced by sendMsgAndWait().

void DtRtiAssistantClient::processRespMsg ( const DtAssistantMsg & respMsg ) [protected, virtual]

References DtAssistantMsg::clone(), and myRespMsg.

bool DtRtiAssistantClient::readAndProcess ( MAKRti::DtTime maxTime ) [protected, virtual]

Read and process any messages on the socket for up to the maxTime.

References DtASSISTANT_INVALID_VERSION, DtASSISTANT_READ_NO_PACKETS, DtASSISTANT_READ_SUCCESS, initialize(), DtTcpMsgSocket::isConnected(), myClock, myMsgCbMgr, mySocket, netRead(), and shutDownConnection().

Referenced by tick().

void DtRtiAssistantClient::removeDisconnectCallback	(	DtAssistantDisconnectCb	cb,
		void *	usr
	)		`[virtual]`

References DtAssistantDisconnectCbInfo::myCb, myDisconnectCallbacks, and DtAssistantDisconnectCbInfo::myUsr.

void DtRtiAssistantClient::removeMsgCallback	(	DtAssistantMsgKind	msgKind,
		DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		`[virtual]`

References myMsgCbMgr.

void DtRtiAssistantClient::removeWildcardMsgCallback	(	DtAssistantMsgCbMgr::DtCallbackFcn	fcn,
		void *	usr
	)		`[virtual]`

References myMsgCbMgr.

void DtRtiAssistantClient::sendClientInfo ( ) [protected, virtual]

intended to be over-ridden by subclasses.

Sends subclass specific data to the assistant.

Reimplemented in DtRtiAssistantLrcClient, DtRtiAssistantExecClient, DtRtiAssistantForwarderClient, DtRtiAssistantToAssistantClient, DtRtiAssistantWwwClient, and DtRtiAssistantShmExecClient.

Referenced by initialize().

void DtRtiAssistantClient::sendClose ( ) [virtual]

Send connection closed message to Assistant.

This should be called prior to a normal shutdown of the client.

References DtAssistantConnMsgKind, msgFactory(), myComponentType, sendMsg(), DtAssistantConnMsg::setComponentType(), and DtAssistantConnMsg::setDisconnect().

Referenced by DtRtiAssistantToAssistantClient::~DtRtiAssistantToAssistantClient().

DtAssistantConnectionStatus DtRtiAssistantClient::sendConnectMsg ( ) [protected, virtual]

Send basic component information to the Assistant for a new connection.

Returns false if the Assistant rejects this connection.

References DtAssistantConnMsg::display(), DtAssistantConnected, DtAssistantConnectRejected, DtAssistantConnMsgKind, DtAssistantNoResponse, DtAssistantWrongDisplay, DtAssistantConnMsg::isDisconnect(), msgFactory(), myComponentType, myCreateIfConnectFails, mySocket, mySocketMutex, sendMsgAndWait(), DtAssistantConnMsg::setComponentType(), DtAssistantConnMsg::setDisconnect(), and DtAssistantConnMsg::setDisplay().

Referenced by makeSingleConnectionAttempt().

void DtRtiAssistantClient::sendDialogBoxMsg	(	const MAKRti::DtString &	text,
		const MAKRti::DtString &	advancedText
	)		`[virtual]`

Send a message to display a dialog notification.

References DtAssistantPopupMsgKind, msgFactory(), sendMsg(), and DtAssistantPopupMsg::set().

Referenced by DtAssistantPopupHelper::sendPopupMessage().

bool DtRtiAssistantClient::sendForwardingComponentConnQueryMsg	(	bool	error,
		MAKRti::DtInetAddr &	relIpAddr,
		MAKRti::DtInetAddr &	beIpAddr,
		MAKRti::DtInetAddr &	interfaceAddr,
		int &	udpPort,
		int &	tcpPort,
		bool &	forceFullCompliance,
		int &	forwarderPort,
		MAKRti::DtInetAddr &	forwardrToConnectTo
	)		`[virtual]`

Send a message querying for the rtiexec connection parameters.

References DtAssistantConnQueryMsg::additionalForwarderConnectionAddr(), DtAssistantConnQueryMsg::bestEffortIpAddress(), DtAssistantConnQueryMsgKind, DtAssistantConnQueryMsg::forceFullCompliance(), DtAssistantConnQueryMsg::forwarderPort(), DtAssistantConnQueryMsg::isAccepted(), msgFactory(), DtAssistantConnQueryMsg::networkInterfaceAddress(), DtAssistantConnQueryMsg::reliableIpAddress(), sendMsgAndWait(), DtAssistantConnQueryMsg::tcpPort(), and DtAssistantConnQueryMsg::udpPort().

void DtRtiAssistantClient::sendLatencyTestMsg ( const DtAssistantLatencyReportMsg & msg ) [virtual]

Send a message to the assistant with latency test measurements.

References sendMsg().

Referenced by DtTestManager::processLatencyTest().

void DtRtiAssistantClient::sendLatencyTestStatusMsg ( const DtAssistantTestMgrStatusMsg & msg ) [virtual]

Send an updated latency test status message to the assistant.

References sendMsg().

Referenced by DtTestManager::sendStatusMessages().

bool DtRtiAssistantClient::sendLicQueryMsg	(	bool	allowUnlicensed,
		bool &	runUnlicensed,
		MAKRti::DtString &	licServer
	)		`[protected, virtual]`

Send a message querying for the license server.

References DtAssistantLicQueryMsgKind, DtAssistantLicQueryMsg::isAccepted(), DtAssistantLicQueryMsg::isUnlicensed(), DtAssistantLicQueryMsg::licenseServer(), msgFactory(), sendMsgAndWait(), and DtAssistantLicQueryMsg::setUnlicensed().

Referenced by getNewLicenseServerFromAssistant().

bool DtRtiAssistantClient::sendLRCConnQueryMsg	(	bool	error,
		MAKRti::DtInetAddr &	relIpAddr,
		MAKRti::DtInetAddr &	beIpAddr,
		MAKRti::DtInetAddr &	interfaceAddr,
		int &	udpPort,
		int &	tcpPort,
		bool &	useRtiexec,
		bool &	forceFullCompliance,
		int &	forwarderPort
	)		`[virtual]`

Send a message querying for the connection parameters.

References DtAssistantConnQueryMsg::bestEffortIpAddress(), DtAssistantConnQueryMsgKind, DtAssistantConnQueryMsg::forceFullCompliance(), DtAssistantConnQueryMsg::forwarderPort(), DtAssistantConnQueryMsg::isAccepted(), msgFactory(), DtAssistantConnQueryMsg::networkInterfaceAddress(), DtAssistantConnQueryMsg::reliableIpAddress(), sendMsgAndWait(), DtAssistantConnQueryMsg::setError(), DtAssistantConnQueryMsg::tcpPort(), DtAssistantConnQueryMsg::udpPort(), and DtAssistantConnQueryMsg::useRtiexec().

bool DtRtiAssistantClient::sendMsg ( const DtAssistantMsg & msg ) [protected, virtual]

Send a message to the RTI Assistant.

returns true if no error.

References initialize(), DtTcpMsgSocket::isConnected(), mySocket, mySocketMutex, and DtTcpMsgSocket::sendMessage().

DtAssistantMsg * DtRtiAssistantClient::sendMsgAndWait	(	const DtAssistantMsg &	msg,
		DtAssistantMsgKind	respKind,
		unsigned int	waitSecs = `0`
	)		`[protected, virtual]`

Send a message to the RTI Assistant and wait for response of the specified kind.

A pointer to the response message will be returned. Ownership of the message is passed to the calling function who must delete it when finished. Optional parameter waitSecs specifies how long we should wait for the response. If 0 is specified, wait is indefinite. Returns null pointer if timeout occurred.

References addMsgCallback(), DtTcpMsgSocket::flush(), initialize(), DtTcpMsgSocket::isConnected(), myClock, myNumSuccessfulAssistantConnects, myRespMsg, myShouldShutdown, mySocket, mySocketMutex, processRespMsg(), removeMsgCallback(), DtTcpMsgSocket::sendMessage(), DtTcpMsgSocket::testConnectionStatus(), and tick().