DtRtiForwarderObserver Class Reference

The DtRtiForwarderObserver is the base class for all observers of RTI Forwarder events. More...

Inheritance diagram for DtRtiForwarderObserver:

Collaboration diagram for DtRtiForwarderObserver:

List of all members.

Public Member Functions
	DtRtiForwarderObserver ()
	Constructor.
virtual	~DtRtiForwarderObserver ()
	Destructor.
virtual void	setMgr (DtRtiForwarderObserverMgr *mgr)
	Sets the manager for this observer.
virtual void	initMgr ()
	Initializes the mgr.
virtual void	removeMgr ()
	Removes the manager for this observer.
Event processing functions
Process RTI Forwarder events
DtRtiForwarderObserverMgr *	myMgr
	Pointer to the observer manager.
virtual int	clientToForwarderConnectionEstablished (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	Callback for established client<->forwarder connections.
virtual int	clientToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	Callback for lost client<->forwarder connections.
virtual void	clientToForwarderFederateJoined (const MAKRti::DtString &connName, const MAKRti::DtString &connType, const MAKRti::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)=0
	Callback for joined client<->forwarder federate connections.
virtual void	clientToForwarderFederateLost (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &connAddr)=0
	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 &connHost, bool fullyCompliant)=0
	Callback for connected forwarder->forwarder exec connections.
virtual int	forwarderToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	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)=0
	Callback for connected client->forwarder exec connections.
virtual int	clientToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	Callback for lost client->forwarder exec connections.
virtual void	forwarderToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	Callback for established forwarder<->forwarder connections.
virtual void	forwarderToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)=0
	Callback for lost forwarder<->forwarder connections.
virtual void	waitingForFowrarderConnections (const DtForwarderPort::DtConnAndNameMap &allNeededFws, const DtForwarderPort::DtConnAndNameMap &stillNeededFws)=0
	Callback to signal that forwarder is waiting for forwarder<->forwarder connections.
virtual void	notWaitingForFowrarderConnections ()=0
	Callback to signal that forwarder is no longer waiting for forwarder<->forwarder connections.
virtual void	addRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, bool isMomCallback=false)
	Register to receive an event whenever an RTI Msg of the specified kind is received.
virtual void	removeRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, bool isMomCallback=false)
	Unregister to receive an event whenever an RTI Msg of the specified kind is received.
virtual void	addTickCallback (DtTickCbFn fcn, MAKRti::DtTime interval)
	Add a tick callback function to be called periodically at the given time interval.
virtual void	removeTickCallback (DtTickCbFn fcn)
	Remove tick callback.
virtual int	clientToForwarderSocketQueueUpdate (unsigned int connId, int connQueueStatus)=0
	Pointer to the observer manager.
virtual unsigned long	connectionId () const
	Get the connection ID for this forwarder (thread safe)
virtual void	addCallbacks ()=0
	Adds all RTI message and tick callbacks. Called when a manager is set.
virtual void	removeCallbacks ()=0
	Removes all RTI message and tick callbacks.
	DtRtiForwarderObserver (const DtRtiForwarderObserver &orig)
	Copy constructor unimplemented.
DtRtiForwarderObserver &	operator= (const DtRtiForwarderObserver &orig)
	Assignment unimplemented.

---

Detailed Description

The DtRtiForwarderObserver is the base class for all observers of RTI Forwarder events.

---

Constructor & Destructor Documentation

DtRtiForwarderObserver::DtRtiForwarderObserver

(

)

Constructor.

DtRtiForwarderObserver::~DtRtiForwarderObserver

(

)

[virtual]

Destructor.

DtRtiForwarderObserver::DtRtiForwarderObserver

(

const DtRtiForwarderObserver &

orig

)

[private]

Copy constructor unimplemented.

---

Member Function Documentation

virtual void DtRtiForwarderObserver::addCallbacks

(

)

[protected, pure virtual]

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

Implemented in DtForwarderObserverForAssistant.

Referenced by initMgr().

void DtRtiForwarderObserver::addRtiMsgCallback	(	DtRtiMsgKind	msgKind,
		DtRtiMsgCbMgr::DtCallbackFcn	fcn,
		bool	isMomCallback = false
	)		[virtual]

Register to receive an event whenever an RTI Msg of the specified kind is received.

References DtRtiForwarderObserverMgr::addRtiMsgCallback(), and myMgr.

void DtRtiForwarderObserver::addTickCallback	(	DtTickCbFn	fcn,
		MAKRti::DtTime	interval
	)		[virtual]

Add a tick callback function to be called periodically at the given time interval.

References DtRtiForwarderObserverMgr::addTickCallback(), and myMgr.

Referenced by DtForwarderObserverForAssistant::addCallbacks(), and DtForwarderObserverForAssistant::DtForwarderObserverForAssistant().

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

Callback for established client<->forwarder connections.

Implemented in DtForwarderObserverForAssistant.

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

Callback for lost client<->forwarder connections.

Implemented in DtForwarderObserverForAssistant.

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

Callback for connected client->forwarder exec connections.

Implemented in DtForwarderObserverForAssistant.

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

Callback for lost client->forwarder exec connections.

Implemented in DtForwarderObserverForAssistant.

virtual void DtRtiForwarderObserver::clientToForwarderFederateJoined	(	const MAKRti::DtString &	connName,
		const MAKRti::DtString &	connType,
		const MAKRti::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
	)		[pure virtual]

Callback for joined client<->forwarder federate connections.

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

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

Implemented in DtForwarderObserverForAssistant.

virtual int DtRtiForwarderObserver::clientToForwarderSocketQueueUpdate	(	unsigned int	connId,
		int	connQueueStatus
	)		[pure virtual]

Pointer to the observer manager.

Implemented in DtForwarderObserverForAssistant.

unsigned long DtRtiForwarderObserver::connectionId

(

)

const [inline, virtual]

Get the connection ID for this forwarder (thread safe)

References DtRtiForwarderObserverMgr::connectionId(), and myMgr.

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

Callback for established forwarder<->forwarder connections.

Implemented in DtForwarderObserverForAssistant.

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

Callback for lost forwarder<->forwarder connections.

Implemented in DtForwarderObserverForAssistant.

virtual int DtRtiForwarderObserver::forwarderToForwarderExecConnected	(	const MAKRti::DtString &	connName,
		unsigned int	connID,
		const DtInetAddrAndPort &	connAddr,
		const MAKRti::DtString &	connHost,
		bool	fullyCompliant
	)		[pure virtual]

Callback for connected forwarder->forwarder exec connections.

Implemented in DtForwarderObserverForAssistant.

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

Callback for lost forwarder->forwarder exec connections.

Implemented in DtForwarderObserverForAssistant.

void DtRtiForwarderObserver::initMgr

(

)

[virtual]

Initializes the mgr.

This helps the initialization order problem by separating the addition of the observer to the mgr from the addition of callbacks to the forwarder (which doesn't exist when setMgr is called).

References addCallbacks(), and myMgr.

virtual void DtRtiForwarderObserver::notWaitingForFowrarderConnections

(

)

[pure virtual]

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

Implemented in DtForwarderObserverForAssistant.

DtRtiForwarderObserver& DtRtiForwarderObserver::operator=

(

const DtRtiForwarderObserver &

orig

)

[private]

Assignment unimplemented.

virtual void DtRtiForwarderObserver::removeCallbacks

(

)

[protected, pure virtual]

Removes all RTI message and tick callbacks.

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

Implemented in DtForwarderObserverForAssistant.

Referenced by removeMgr().

void DtRtiForwarderObserver::removeMgr

(

)

[virtual]

Removes the manager for this observer.

References myMgr, and removeCallbacks().

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

void DtRtiForwarderObserver::removeRtiMsgCallback	(	DtRtiMsgKind	msgKind,
		DtRtiMsgCbMgr::DtCallbackFcn	fcn,
		bool	isMomCallback = false
	)		[virtual]

Unregister to receive an event whenever an RTI Msg of the specified kind is received.

References myMgr, and DtRtiForwarderObserverMgr::removeRtiMsgCallback().

void DtRtiForwarderObserver::removeTickCallback

(

DtTickCbFn

fcn

)

[virtual]

Remove tick callback.

References myMgr, and DtRtiForwarderObserverMgr::removeTickCallback().

Referenced by DtForwarderObserverForAssistant::removeCallbacks().

void DtRtiForwarderObserver::setMgr

(

DtRtiForwarderObserverMgr *

mgr

)

[virtual]

Sets the manager for this observer.

References myMgr, and removeMgr().

virtual void DtRtiForwarderObserver::waitingForFowrarderConnections	(	const DtForwarderPort::DtConnAndNameMap &	allNeededFws,
		const DtForwarderPort::DtConnAndNameMap &	stillNeededFws
	)		[pure virtual]

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

Implemented in DtForwarderObserverForAssistant.

---

Member Data Documentation

DtRtiForwarderObserverMgr* DtRtiForwarderObserver::myMgr [protected]

Pointer to the observer manager.

Referenced by addRtiMsgCallback(), addTickCallback(), connectionId(), initMgr(), removeMgr(), removeRtiMsgCallback(), removeTickCallback(), DtForwarderObserverForAssistant::sendForwarderInfoToAssistant(), and setMgr().

---

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

• forwarderObserver.h
• forwarderObserver.cxx