Observes the RTI Forwarder and is responsible sending information on RTI Forwarder to the RTI Assistant. More...

Inheritance diagram for DtForwarderObserverForAssistant:

Collaboration diagram for DtForwarderObserverForAssistant:

Classes
struct	DtForwarderObserverConnInfo
struct	DtForwarderObserverDroppedConnInfo
Public Member Functions
	DtForwarderObserverForAssistant ()
virtual	~DtForwarderObserverForAssistant ()
virtual void	initialize (DtRIDParameters *params)
	Initialization.
virtual void	queryForConnectionInfo (int &forwarderPort, MAKRti::DtInetAddr &forwarderToConnectTo)
virtual void	setForwarderInfo (int forwarderPort, const MAKRti::DtInetAddr &forwarderToConnectTo)
	If we're not querying the assistant, provide some way for the forwarder to indicate what its forwarderConnInfo is.
virtual void	enableNotifications ()
	Enables sending DtWarn & DtFatal to assistant as notifications.
virtual void	disableNotifications ()
	Disables sending DtWarn & DtFatal to assistant as notifications.
virtual void	processLogFileUpdatedEvent (const MAKRti::DtFilename &logFile)
	Process a log file name update event.
virtual int	clientToForwarderConnectionEstablished (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for established joined client<->forwarder connections.
virtual int	clientToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for lost client<->forwarder connections.
virtual void	clientToForwarderFederateJoined (const DtString &connName, const DtString &connType, const DtString &federationName, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &connHost, unsigned int processId, const MAKRti::DtString &processName, const MAKRti::DtString &commandArgs, DtHlaVersionId hlaVersion)
	Callback for fully joined client<->forwarder connections.
virtual void	clientToForwarderFederateLost (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &connAddr)
	Callback for lost client<->forwarder connections that were fully joined.
virtual int	forwarderToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &hostName, bool fullyCompliant)
	Callback for connected forwarder<->forwarder exec connections.
virtual int	forwarderToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for lost forwarder<->forwarder exec connections.
virtual int	clientToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &connHost, bool fullyCompliant)
	Callback for connected client->forwarder exec connections.
virtual int	clientToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for lost client->forwarder exec connections.
virtual void	forwarderToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for established forwarder<->forwarder connections.
virtual void	forwarderToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
	Callback for lost forwarder<->forwarder connections.
virtual int	clientToForwarderSocketQueueUpdate (unsigned int connId, int connQueueStatus)
	Callback for socket queue update.
virtual void	waitingForFowrarderConnections (const DtForwarderPort::DtConnAndNameMap &allNeededFws, const DtForwarderPort::DtConnAndNameMap &stillNeededFws)
	Callback to signal that forwarder is waiting for forwarder<->forwarder connections.
virtual void	notWaitingForFowrarderConnections ()
	Callback to signal that forwarder is no longer waiting for forwarder<->forwarder connections.
bool	gotConnInfoFromAssistant ()
	/brief Returns true if the assistant supplied the RTI Forwarder connection info.
DtBoost::shared_ptr < DtRtiAssistantForwarderClient >	assistantClient ()
Protected Member Functions
virtual void	addCallbacks ()
	/brief Adds all RTI message and tick callbacks. Called when a manager is set.
virtual void	removeCallbacks ()
	/brief Removes all RTI message and tick callbacks.
virtual void	sendForwarderInfoToAssistant () const
	/brief Populates necessary data and sends it to the assistant client (for observation requests)
virtual void	sendWaitingForForwardersToAssistant () const
	/brief Populates necessary data and sends a message to the assistant specifying that we are waiting for additional forwarder connections.
Protected Attributes
DtBoost::shared_ptr < DtRtiAssistantForwarderClient >	myAssistantClient
	The assistant client.
DtAssistantPrinter *	myAssistantPrinter
	The printer which sends notifications to the assistant.
bool	myForwarderIsObserved
	Whether or not there is currently an assistant observing this RTI Forwarder.
DtRIDParameters *	myParams
	The RID parameter settings.
MAKRti::DtInetAddr	myHostAddr
	The host address used for connection.
bool	myGotConnInfoFromAssistant
	Whether or not the assistant supplied connection info.
std::set < DtForwarderObserverConnInfo >	myConnectedNotJoinedClientConns
std::set < DtForwarderObserverConnInfo >	myClientForwarderConns
std::set < DtForwarderObserverConnInfo >	myForwarderForwarderConns
std::set < DtForwarderObserverDroppedConnInfo >	myUnexpectedlyDroppedClientConns
DtNeededFwConnMap	myNeededFws
	List of forwarders which we are trying to connect to and whether or not a connection has been made.
bool	myIsWaitingForFws
	Whether we are still waiting for forwarder connections.
MAKRti::DtClock	myClock
float	myDefunctRemovalTime
DtForwarderObserverConnInfo *	myExecConnection
bool	myExecIsLocal

int	myForwarderPort
	Forwarder connection information.
MAKRti::DtInetAddr	myForwarderToConnectTo
	Forwarder connection information.
event processing functions
virtual void	tick ()
	Periodic processing.
static void	tick (void *usr)
	Callback for periodic processing.
RTI Assistant message processing callbacks
virtual void	processForwarderObserveMsg (const DtAssistantStateObserveMsg &msg)
	/brief Process forwarder observe message by enabling or disabling forwarder update messages to the assistant
virtual void	processExitCmndMsg (const DtAssistantExitMsg &msg)
	Process exit command.
virtual void	processAssistantDisconnect ()
	Process assistant disconnect.
static void	processForwarderObserveMsg (const DtAssistantStateObserveMsg &msg, void *usr)
	/brief Callback for a command message notifying this forwarder that it is or is not being observed
static void	processExitCmndMsg (const DtAssistantExitMsg &msg, void *usr)
	/brief Callback for exit command message
static void	processAssistantDisconnect (void *usr)
	/brief Callback for assistant disconnect

Detailed Description

Observes the RTI Forwarder and is responsible sending information on RTI Forwarder to the RTI Assistant.

Also accepts commands from the Assistant and gives them to the RTI Forwarder for processing.

Constructor & Destructor Documentation

DtForwarderObserverForAssistant::DtForwarderObserverForAssistant ( )

References DtAssistantExitMsg::addCallback(), DtAssistantStateObserveMsg::addCallback(), DtRtiForwarderObserver::addTickCallback(), determineClientAndServerPorts(), DtAssistantForwarderComponent, myAssistantClient, myAssistantPrinter, myClock, processAssistantDisconnect(), processExitCmndMsg(), processForwarderObserveMsg(), and tick().

DtForwarderObserverForAssistant::~DtForwarderObserverForAssistant ( ) [virtual]

References myAssistantClient, myAssistantPrinter, processAssistantDisconnect(), processExitCmndMsg(), processForwarderObserveMsg(), DtAssistantExitMsg::removeCallback(), DtAssistantStateObserveMsg::removeCallback(), and DtRtiForwarderObserver::removeMgr().

Member Function Documentation

void DtForwarderObserverForAssistant::addCallbacks ( ) [protected, virtual]

/brief Adds all RTI message and tick callbacks. Called when a manager is set.

Implements DtRtiForwarderObserver.

References DtRtiForwarderObserver::addTickCallback(), and tick().

DtBoost::shared_ptr<DtRtiAssistantForwarderClient> DtForwarderObserverForAssistant::assistantClient ( ) [inline]

int DtForwarderObserverForAssistant::clientToForwarderConnectionEstablished	(	const MAKRti::DtString &	connName,
		const MAKRti::DtString &	connType,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for established joined client<->forwarder connections.

Implements DtRtiForwarderObserver.

References myConnectedNotJoinedClientConns.

int DtForwarderObserverForAssistant::clientToForwarderConnectionLost	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for lost client<->forwarder connections.

Implements DtRtiForwarderObserver.

References myClientForwarderConns, myClock, myConnectedNotJoinedClientConns, myForwarderIsObserved, myUnexpectedlyDroppedClientConns, and sendForwarderInfoToAssistant().

int DtForwarderObserverForAssistant::clientToForwarderExecConnected	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr,
		const MAKRti::DtString &	connHost,
		bool	fullyCompliant
	)		`[virtual]`

Callback for connected client->forwarder exec connections.

Implements DtRtiForwarderObserver.

References myAssistantClient, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnAddr, myConnectedNotJoinedClientConns, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnID, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnName, myExecConnection, myExecIsLocal, myForwarderIsObserved, and sendForwarderInfoToAssistant().

int DtForwarderObserverForAssistant::clientToForwarderExecLost	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for lost client->forwarder exec connections.

Implements DtRtiForwarderObserver.

References myAssistantClient, myExecConnection, myExecIsLocal, myForwarderIsObserved, and sendForwarderInfoToAssistant().

void DtForwarderObserverForAssistant::clientToForwarderFederateJoined	(	const DtString &	connName,
		const DtString &	connType,
		const DtString &	federationName,
		unsigned int	connID,
		unsigned int	fedHandle,
		const DtInetAddrAndPort &	connAddr,
		const MAKRti::DtString &	connHost,
		unsigned int	processId,
		const MAKRti::DtString &	processName,
		const MAKRti::DtString &	commandArgs,
		DtHlaVersionId	hlaVersion
	)		`[virtual]`

Callback for fully joined client<->forwarder connections.

References myClientForwarderConns, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnCommandArgs, myConnectedNotJoinedClientConns, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnPID, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnProcessName, myForwarderIsObserved, and sendForwarderInfoToAssistant().

void DtForwarderObserverForAssistant::clientToForwarderFederateLost	(	const MAKRti::DtString &	connName,
		const MAKRti::DtString &	connType,
		unsigned int	connID,
		unsigned int	fedHandle,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for lost client<->forwarder connections that were fully joined.

Implements DtRtiForwarderObserver.

References myClientForwarderConns, myConnectedNotJoinedClientConns, myForwarderIsObserved, and sendForwarderInfoToAssistant().

int DtForwarderObserverForAssistant::clientToForwarderSocketQueueUpdate	(	unsigned int	connId,
		int	connQueueStatus
	)		`[virtual]`

Callback for socket queue update.

Implements DtRtiForwarderObserver.

References myClientForwarderConns, and sendForwarderInfoToAssistant().

void DtForwarderObserverForAssistant::disableNotifications ( ) [virtual]

Disables sending DtWarn & DtFatal to assistant as notifications.

References myAssistantPrinter.

void DtForwarderObserverForAssistant::enableNotifications ( ) [virtual]

Enables sending DtWarn & DtFatal to assistant as notifications.

References myAssistantPrinter.

void DtForwarderObserverForAssistant::forwarderToForwarderConnectionEstablished	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for established forwarder<->forwarder connections.

Implements DtRtiForwarderObserver.

References myForwarderForwarderConns, myForwarderIsObserved, myIsWaitingForFws, myNeededFws, sendForwarderInfoToAssistant(), and sendWaitingForForwardersToAssistant().

void DtForwarderObserverForAssistant::forwarderToForwarderConnectionLost	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for lost forwarder<->forwarder connections.

Implements DtRtiForwarderObserver.

References myForwarderForwarderConns, myForwarderIsObserved, and sendForwarderInfoToAssistant().

int DtForwarderObserverForAssistant::forwarderToForwarderExecConnected	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr,
		const MAKRti::DtString &	hostName,
		bool	fullyCompliant
	)		`[virtual]`

Callback for connected forwarder<->forwarder exec connections.

Implements DtRtiForwarderObserver.

References myAssistantClient, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnAddr, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnID, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnName, myExecConnection, myExecIsLocal, myForwarderIsObserved, and sendForwarderInfoToAssistant().

int DtForwarderObserverForAssistant::forwarderToForwarderExecLost	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr
	)		`[virtual]`

Callback for lost forwarder<->forwarder exec connections.

Implements DtRtiForwarderObserver.

References myAssistantClient, myExecConnection, myForwarderIsObserved, and sendForwarderInfoToAssistant().

bool DtForwarderObserverForAssistant::gotConnInfoFromAssistant ( ) [inline]

/brief Returns true if the assistant supplied the RTI Forwarder connection info.

References myGotConnInfoFromAssistant.

void DtForwarderObserverForAssistant::initialize ( DtRIDParameters * params ) [virtual]

Initialization.

References myParams.

void DtForwarderObserverForAssistant::notWaitingForFowrarderConnections ( ) [virtual]

Callback to signal that forwarder is no longer waiting for forwarder<->forwarder connections.

Implements DtRtiForwarderObserver.

References myIsWaitingForFws, myNeededFws, and sendWaitingForForwardersToAssistant().

void DtForwarderObserverForAssistant::processAssistantDisconnect ( void * usr ) [static]

/brief Callback for assistant disconnect

References processAssistantDisconnect().

void DtForwarderObserverForAssistant::processAssistantDisconnect ( ) [virtual]

Process assistant disconnect.

Referenced by DtForwarderObserverForAssistant(), processAssistantDisconnect(), and ~DtForwarderObserverForAssistant().

void DtForwarderObserverForAssistant::processExitCmndMsg	(	const DtAssistantExitMsg &	msg,
		void *	usr
	)		`[static]`

/brief Callback for exit command message

Callback for exit command message.

Referenced by DtForwarderObserverForAssistant(), and ~DtForwarderObserverForAssistant().

void DtForwarderObserverForAssistant::processExitCmndMsg ( const DtAssistantExitMsg & msg ) [virtual]

Process exit command.

void DtForwarderObserverForAssistant::processForwarderObserveMsg	(	const DtAssistantStateObserveMsg &	msg,
		void *	usr
	)		`[static]`

/brief Callback for a command message notifying this forwarder that it is or is not being observed

Referenced by DtForwarderObserverForAssistant(), and ~DtForwarderObserverForAssistant().

void DtForwarderObserverForAssistant::processForwarderObserveMsg ( const DtAssistantStateObserveMsg & msg ) [virtual]

/brief Process forwarder observe message by enabling or disabling forwarder update messages to the assistant

References DtAssistantStateObserveForwarder, DtAssistantStateObserveForwarderPersistent, DtAssistantStateObserveMsg::getDefunctRemovalTime(), DtAssistantStateObserveMsg::isLogRequest(), DtAssistantStateObserveMsg::isObserved(), myDefunctRemovalTime, myForwarderIsObserved, sendForwarderInfoToAssistant(), and DtAssistantStateObserveMsg::targetType().

void DtForwarderObserverForAssistant::processLogFileUpdatedEvent ( const MAKRti::DtFilename & logFile ) [virtual]

Process a log file name update event.

void DtForwarderObserverForAssistant::queryForConnectionInfo	(	int &	forwarderPort,
		MAKRti::DtInetAddr &	forwarderToConnectTo
	)		`[virtual]`

References DtRIDParameters::configureConnectionWithRid, DtRIDParameters::DtFomTransportTypeUseFomSettings, DtRIDParameters::forceParametersToCompliance(), myAssistantClient, myForwarderPort, myForwarderToConnectTo, myGotConnInfoFromAssistant, myParams, DtRIDParameters::setNetworkInterfaceAddr(), DtRIDParameters::setTcpForwarderAddr(), DtRIDParameters::setUseRoutesFile(), and tcpPort.

void DtForwarderObserverForAssistant::removeCallbacks ( ) [protected, virtual]

/brief Removes all RTI message and tick callbacks.

Called when a manager is removed or the observer is destroyed.

Implements DtRtiForwarderObserver.

References DtRtiForwarderObserver::removeTickCallback(), and tick().

void DtForwarderObserverForAssistant::sendForwarderInfoToAssistant ( ) const [protected, virtual]

/brief Populates necessary data and sends it to the assistant client (for observation requests)

References DtRtiForwarderObserverMgr::connectionAddr(), DtRtiForwarderObserverMgr::connectionId(), DtRtiForwarderObserverMgr::connectionName(), DtHlaVersionUnknown, myAssistantClient, myClientForwarderConns, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnAddr, myConnectedNotJoinedClientConns, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnHost, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myConnQueueStatus, myExecConnection, myExecIsLocal, DtForwarderObserverForAssistant::DtForwarderObserverConnInfo::myFedHandle, myForwarderForwarderConns, DtRtiForwarderObserver::myMgr, and myUnexpectedlyDroppedClientConns.

Referenced by clientToForwarderConnectionLost(), clientToForwarderExecConnected(), clientToForwarderExecLost(), clientToForwarderFederateJoined(), clientToForwarderFederateLost(), clientToForwarderSocketQueueUpdate(), forwarderToForwarderConnectionEstablished(), forwarderToForwarderConnectionLost(), forwarderToForwarderExecConnected(), forwarderToForwarderExecLost(), processForwarderObserveMsg(), and tick().

void DtForwarderObserverForAssistant::sendWaitingForForwardersToAssistant ( ) const [protected, virtual]

/brief Populates necessary data and sends a message to the assistant specifying that we are waiting for additional forwarder connections.

References myAssistantClient, myIsWaitingForFws, and myNeededFws.

Referenced by forwarderToForwarderConnectionEstablished(), notWaitingForFowrarderConnections(), and waitingForFowrarderConnections().

void DtForwarderObserverForAssistant::setForwarderInfo	(	int	forwarderPort,
		const MAKRti::DtInetAddr &	forwarderToConnectTo
	)		`[virtual]`

If we're not querying the assistant, provide some way for the forwarder to indicate what its forwarderConnInfo is.

References myForwarderPort, and myForwarderToConnectTo.

void DtForwarderObserverForAssistant::tick ( void * usr ) [static]

Callback for periodic processing.

References tick().

void DtForwarderObserverForAssistant::tick ( ) [virtual]

Periodic processing.

References myAssistantClient, myClock, myDefunctRemovalTime, myUnexpectedlyDroppedClientConns, and sendForwarderInfoToAssistant().

Referenced by addCallbacks(), DtForwarderObserverForAssistant(), removeCallbacks(), and tick().

void DtForwarderObserverForAssistant::waitingForFowrarderConnections	(	const DtForwarderPort::DtConnAndNameMap &	allNeededFws,
		const DtForwarderPort::DtConnAndNameMap &	stillNeededFws
	)		`[virtual]`