DtExtendedRtiMsgForwarder Class Reference

Inheritance diagram for DtExtendedRtiMsgForwarder:

Collaboration diagram for DtExtendedRtiMsgForwarder:

Public Types
typedef DtThreadSafeBufferQueue< char >	DtCharBufferQueue
Public Types inherited from DtRtiMsgForwarder
typedef DtBoost::shared_ptr < ConnectionInfo >	ConnectionInfoSP
typedef DtBoost::weak_ptr < ConnectionInfo >	ConnectionInfoWP
typedef std::map< const DtTcpMsgSocket *, ConnectionInfoSP >	SocketToConnInfoMap

Public Member Functions
virtual	~DtExtendedRtiMsgForwarder ()
	Default Dtor.
virtual void	applyFilters ()
	Instruct the forwarder to register all filters - called after all desired filters are registered (accessor for protected base member: applyRegisteredFilters)
virtual void	sendByTransport (const DtForwarderPort::DtForwarderMsg &msg)
	Check transport metadata and send message to appropriate socket(s)
virtual void	sendToAllReliable (const DtForwarderPort::DtForwarderMsg &msg)
	Apply registered filters and send message to unfiltered TCP sockets.
virtual void	sendBestEffort (const DtForwarderPort::DtForwarderMsg &msg)
	Apply registered filters and send message to LAN via UDP socket.
virtual void	sendMessageToWan (const DtRtiMsg &msg)
	Allow filters to send messages only to the WAN (not back to the LAN) (useful to distributed forwarder mode filters)
virtual bool	flush ()
	Send buffered messages.
virtual const DtCharBufferQueue::Buffer *	getNextMsg ()
	Get the next message received from the connected sockets.
virtual void	selectParams (MAKRti::DtSelectParamWithWrite &selectParams)
	Get a set of file descriptors to select against for socket notification.
virtual DtForwarderPort::DtAddressPortList	newConnections () const
	Get the list of connections created since last call.
virtual DtForwarderPort::DtAddressPortList	droppedConnections () const
	Get the list of connections lost since last call.
virtual DtForwarderPort::DtAddressPortList	connections () const
	Get the list of all current connections to this port.
virtual void	listenToMulticastGroup (const MAKRti::DtInetAddr &mcastAddr)
	Listen / drop multicast groups.
virtual void	dropMulticastGroup (const MAKRti::DtInetAddr &mcastAddr)
virtual void	federateJoined (const MAKRti::DtString &, const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, unsigned int, const DtInetAddrAndPort &, const MAKRti::DtString &, unsigned int, const MAKRti::DtString &, const MAKRti::DtString &, DtHlaVersionId)
	callbacks when the federate tracking filter notices a federate join/resign event.
virtual void	federateResigned (const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, unsigned int, const DtInetAddrAndPort &)
virtual void	updateSocketQueueStatus (unsigned int connId, int connQueueStatus)
virtual void	addFederateJoinedCb (DtForwarderPort::DtFederateAddedCb callback, void *usr)
virtual void	addFederateResignedCb (DtForwarderPort::DtFederateRemovedCb callback, void *usr)
virtual void	addSocketAdditionCb (DtForwarderPort::DtConnectionChangeCb cb, void *usr)
virtual void	addSocketRemovalCb (DtForwarderPort::DtConnectionChangeCb cb, void *usr)
virtual void	addSocketQueueCb (DtForwarderPort::DtSocketQueueCb cb, void *usr)
virtual void	addExecConnectionEstablishedCb (DtForwarderPort::DtExecAddChangeCb callback, void *usr)
	Register/Unregister a callback for new connections.
virtual void	removeExecConnectionEstablishedCb (DtForwarderPort::DtExecAddChangeCb callback, void *usr)
virtual void	addExecConnectionLostCb (DtForwarderPort::DtExecRemovedChangeCb callback, void *usr)
	Register/Unregister a callback for new connections.
virtual void	removeExecConnectionLostCb (DtForwarderPort::DtExecRemovedChangeCb callback, void *usr)
virtual const DtFederateTrackingFilter *	fedHandleTrackingFilter () const
Public Member Functions inherited from DtRtiMsgForwarder
virtual	~DtRtiMsgForwarder ()
	Destructor.
virtual bool	hasExec () const
	Query the rtiExec Handshake monitor for whether it has an exec.
virtual void	run ()
	Main execution routine.
virtual void	setEnableBundling (unsigned int maxBundleSize)
	Get the rtiexec's socket if known.
virtual void	setUseSmartForwarding (bool yesNo)
	Enable Smart DM Subscription Filtering.
virtual void	setUseInternalSmartForwarding (bool yesNo)
	Enable Smart DM Subscription Filtering for internal messages.
virtual void	setRouteFedexMessages (bool yesNo)
	Enable Smart Fedex Message Filtering.
virtual void	addPacketFilter (DtMessageFilter *filter)
	[Un]Register a forwarding filter on incoming packets
virtual void	removePacketFilter (DtMessageFilter *filter)
virtual unsigned long	forwarderId () const
	Return the forwarder ID (defines the address space for connIds for this forwarder)
virtual void	setForwarderId (unsigned long newId)
	set the forwarder ID.
void	updateTcpForwarderQueuedSockets ()
	update the tcp forwarders queued sockets
virtual const DtRtiMsgForwarder::SocketToConnInfoMap &	getConnToConnInfoMap () const
	WARNING: These methods are not thread-safe and may only be called by the back-end forwarder thread!
virtual ConnectionInfoSP	getConnectionInfoByConnId (unsigned long connId) const
	Get a shared pointer to the connection info for a connection by Conn ID.
virtual ConnectionInfoSP	getConnectionInfoByHandle (unsigned long federateHandle) const
	Get a shared pointer to the connection info for a connection by Federate Handle.
virtual ConnectionInfoSP	getConnectionInfoBySocket (const DtTcpMsgSocket *sock) const
	Get a shared pointer to the connection info for a connection by Socket.
virtual std::pair< bool, unsigned long >	rtiExecConnected () const
	Is the rtiexec connected and if so what is its connId?
virtual void	sendMessage (const DtRtiMsg &msg, const DtTcpMsgSocket *src=0)
	Send a message to all local sockets (filters will be applied)
virtual void	requestCloseAllConnections ()
	Disconnect all open connections after this pass through run-loop completes.
virtual void	requestKillSingleConnection (const DtTcpMsgSocket *sock)
	Disconnect the requestedTcpSocket.
virtual void	markConnectionAsAboutToBeDeleted (DtTcpMsgSocket const *socket, unsigned int connectionId)
	Mark the given socket as one that is to be deleted silently.
virtual bool	isConnectionMarkedForDeletion (unsigned int connectionId) const
	Return boolean: given connection has been marked for deletion?
virtual void	removeOldConnection (unsigned int connectionId)
	Remove the socket specified by the given connection.
virtual void	shutdownRequestedByExec ()
	Shutdown the forwarder application.
virtual bool	updateFederateConnectionId (unsigned long orig, unsigned long final)
	Set a locally connected federate's connId in the associated connection info struct.
virtual void	updateConnectionProcessParameters (unsigned long connId, unsigned long processId, MAKRti::DtString processName, MAKRti::DtString commandArgs)
	Set a connections process information.
virtual bool	shouldStop ()
	should this forwarder stop.

Static Public Member Functions
static DtExtendedRtiMsgForwarder *	create (unsigned int id, const DtRIDParameters &params, bool postMessagesToParent=true)
	Creator.
Static Public Member Functions inherited from DtRtiMsgForwarder
static DtRtiMsgForwarder *	create (unsigned long id, const DtRIDParameters &params)
	Create an instance of a DtRtiMsgForwarder.
static void	setCreatorFunction (DtRtiMsgFwderCreator fn)
	Call this function to set an alternate creator function With this function, users can replace this DtRtiMsgForwarder with their own derived class.
static void	tcpSocketAdditionCb (DtTcpMsgSocket *sock, void *usr)
	Callbacks on addition/removal of TCP sockets.
static void	tcpSocketRemovalCb (DtTcpMsgSocket *sock, void *usr)

Static Public Attributes
static const unsigned int	theForwarderId
	Address space for connection IDs for this LAN.

Protected Types
typedef std::pair < DtInetAddrAndPort, int >	DtAddressAndSockIdPair
typedef std::pair< bool, DtAddressAndSockIdPair >	DtBoolAddressSocketIdPair
	These lists are mutable since they are simply used to cache a reflection of back-end thread lists (rather than requiring synchronization)

Protected Member Functions
	DtExtendedRtiMsgForwarder (unsigned long id, const DtRIDParameters &params, bool postMessagesToParent=true)
	Default Ctor.
virtual void	init ()
	Virtual ctor idiom (continues initialization after both base and derived are initialized)
virtual void	tcpSocketAdditionCb (DtTcpMsgSocket *sock)
	Over-ride socket addition/removal callback to track socket list.
virtual void	tcpSocketRemovalCb (DtTcpMsgSocket *sock)
virtual void	refreshConnectionList () const
	Get all changes to connections since last call This method is const so that const front-end threads can call it.
Protected Member Functions inherited from DtRtiMsgForwarder
	DtRtiMsgForwarder (unsigned long id, const DtRIDParameters &params)
	Default Constructor.
virtual void	performMcastDiscovery ()
virtual void	applyRegisteredFilters ()
	Enable / Disable all filters registered with forwarder.
virtual void	disableRegisteredFilters ()
virtual void	waitForIo ()
	Wait on sockets for next IO event (allows RTIspy users to control the wait mechanism and period)
virtual unsigned long	consumeConnId ()
	Get and consume Connection ID.
virtual void	preRunLoopEvent ()
	Plug-in defined Run Loop operations Gives users the ability to add functionality to the Run() loop without over-riding it completely.
virtual void	runLoopEvent ()
virtual void	postRunLoopEvent ()
virtual bool	populateConnectionInformation (unsigned int &numForwarderToForwarderConns, std::vector< MAKRti::DtString > &forwarderIdentifiers, std::vector< MAKRti::DtString > &forwarderConnectionHostNames, std::vector< MAKRti::DtInetAddr > &forwarderConnectionAddrs, unsigned int &numForwarderClientConns, std::vector< MAKRti::DtString > &clientConnectionHostNames, std::vector< MAKRti::DtInetAddr > &clientConnectionAddrs) const
virtual void	closeAllConnectionsIfRequested ()
	Disconnect all open connections.
	DtRtiMsgForwarder (const DtRtiMsgForwarder &orig)
	Copy Ctor and Assignment Operator unimplemented.
DtRtiMsgForwarder &	operator= (const DtRtiMsgForwarder &orig)

Protected Attributes
DtUdpMsgSocket *	myUdpRcvSocket
DtUdpMsgSocket *	myUdpSendSocket
std::auto_ptr < DtCharBufferQueue::Buffer >	myLastReceivedMsg
DtCharBufferQueue	myInMsgQueue
DtCharBufferQueue	myOutMsgQueue
DtMessageBufferFilter *	myOutMsgFilter
DtFederateTrackingFilter *	myFedHandleTracker
DtClock	myClock
	Local timer.
MAKRti::DtTime	myLastDiscoveryTickTime
	Time of last pass for mcast discovery.
DtForwarderPort::DtFederateAddedCallbackList	myFederateJoinedCbs
DtForwarderPort::DtFederateRemovedCallbackList	myFederateResignedCbs
DtForwarderPort::DtSocketQueueCallbackList	mySocketQueueCbs
DtForwarderPort::DtCallbackList	mySocketAddedCbs
DtForwarderPort::DtCallbackList	mySocketRemovedCbs
DtThreadSafeQueue < DtBoolAddressSocketIdPair >	mySocketListChanges
std::set< DtAddressAndSockIdPair >	myConnections
DtForwarderPort::DtAddressPortList	myNewConnections
DtForwarderPort::DtAddressPortList	myDroppedConnections
bool	myForwardMessagesToParent
	Should the local forwarder pass a copy of all messages on to the Parent or simply forward within the local LAN (allows optimization when this is a stand-alone forwarder)
Protected Attributes inherited from DtRtiMsgForwarder
unsigned long	myForwarderId
	Data Members.
MAKRti::DtInetAddr	myForwarderAddr
	Local host IP address (used by rtiExec monitor filter, among other uses)
bool	myCloseAllConnectionsRequested
	Connection shutdown requested?
DtFilteredTcpForwarder *	myTcpForwarder
	Tcp Forwarder with Filtering Capabilities.
DtTcpMsgSocketMgr *	mySocketMgr
	Tcp Socket Manager (handles passive connections to Federates)
int	myPort
	Port for local federate connections.
int	myTcpNoDelay
unsigned long	myNextConnectionIdOffset
	The ID to be assigned to the next Federate or Forwarder connection The IDs are offset from the forwarderId.
unsigned int	myPacketBundleSize
	Packet Bundle size (if bundle size = 0, bundling is disabled)
DtRtiExecTrackingFilter *	myRtiExecMonitor
	If registered, Monitors rtiexec connection life-cycle.
DtRoutePrinterFilter *	myRoutePrinter
	Smart DM Forwarding Filters.
DtInternalRoutePrinterFilter *	myInternalRoutePrinter
DtUpdateInterRoutingFilter *	myDmMsgRouter
DtInternalRoutingFilter *	myIntMsgRouter
DtFedexMsgFilter *	myFedexMsgRouter
	Fedex Routing Filter.
DtConnectConfirmFilter *	myConnectConfirmFilter
	Extracts info from connect confirm messages.
DtDeleteSocketFilter *	mySocketMonitor
	Marks sockets that are being disconnected normally so that no complaint is given when they disconnect versus abnormal disconnect.
const DtRIDParameters &	myParams
	Local access to the RID Parameters.
DtMulitcastDiscoveryMgr	myMcastDiscoveryMgr
DtThreadSafe< std::deque < DtMsgFwdrFunctor * > >	myPendingProxyCommands
std::vector< DtMessageFilter * >	myRegisteredFilters
	Registered Message Filters.
SocketToConnInfoMap	myConnToConnInfoMap
	Map from socket (conn) to ConnectionInfo object for that connection notes:
std::set< DtTcpMsgSocket const * >	myConnectionsAboutToBeDeleted
	Set of connections that when deleted there should be no complaint.
MAKRti::DtSelectParamWithWrite	mySelectParams
bool	myShouldStop
	should this forwarder stop.

Additional Inherited Members
Static Protected Attributes inherited from DtRtiMsgForwarder
static DtRtiMsgFwderCreator	theCreator

Member Typedef Documentation

typedef std::pair< DtInetAddrAndPort, int > DtExtendedRtiMsgForwarder::DtAddressAndSockIdPair

protected

typedef std::pair< bool, DtAddressAndSockIdPair > DtExtendedRtiMsgForwarder::DtBoolAddressSocketIdPair

protected

These lists are mutable since they are simply used to cache a reflection of back-end thread lists (rather than requiring synchronization)

• changes to the actual lists occur asynchronously in the back-end, so these lists may need to be updated before any use.

typedef DtThreadSafeBufferQueue<char> DtExtendedRtiMsgForwarder::DtCharBufferQueue

Constructor & Destructor Documentation

DtExtendedRtiMsgForwarder::DtExtendedRtiMsgForwarder ( unsigned long  id, const DtRIDParameters &  params, bool  postMessagesToParent = true  )

protected

Default Ctor.

virtual DtExtendedRtiMsgForwarder::~DtExtendedRtiMsgForwarder ( )

virtual

Default Dtor.

Member Function Documentation

virtual void DtExtendedRtiMsgForwarder::addExecConnectionEstablishedCb ( DtForwarderPort::DtExecAddChangeCb  callback, void *  usr  )

virtual

Register/Unregister a callback for new connections.

virtual void DtExtendedRtiMsgForwarder::addExecConnectionLostCb ( DtForwarderPort::DtExecRemovedChangeCb  callback, void *  usr  )

virtual

Register/Unregister a callback for new connections.

virtual void DtExtendedRtiMsgForwarder::addFederateJoinedCb ( DtForwarderPort::DtFederateAddedCb  callback, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::addFederateResignedCb ( DtForwarderPort::DtFederateRemovedCb  callback, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::addSocketAdditionCb ( DtForwarderPort::DtConnectionChangeCb  cb, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::addSocketQueueCb ( DtForwarderPort::DtSocketQueueCb  cb, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::addSocketRemovalCb ( DtForwarderPort::DtConnectionChangeCb  cb, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::applyFilters ( )

virtual

Instruct the forwarder to register all filters - called after all desired filters are registered (accessor for protected base member: applyRegisteredFilters)

virtual DtForwarderPort::DtAddressPortList DtExtendedRtiMsgForwarder::connections ( ) const

virtual

Get the list of all current connections to this port.

static DtExtendedRtiMsgForwarder* DtExtendedRtiMsgForwarder::create ( unsigned int  id, const DtRIDParameters &  params, bool  postMessagesToParent = true  )

static

Creator.

• Caller may set postMessagesToParent as an optimization if there is never any need for the parent to access the message stream (ie - if this is being used by a stand-alone forwarder and getNextMsg is used simply to tick the Forwarder)

virtual void DtExtendedRtiMsgForwarder::dropMulticastGroup ( const MAKRti::DtInetAddr &  mcastAddr )

virtual

virtual DtForwarderPort::DtAddressPortList DtExtendedRtiMsgForwarder::droppedConnections ( ) const

virtual

Get the list of connections lost since last call.

virtual void DtExtendedRtiMsgForwarder::federateJoined ( const MAKRti::DtString &  , const MAKRti::DtString &  , const MAKRti::DtString &  , unsigned  int, unsigned  int, const DtInetAddrAndPort &  , const MAKRti::DtString &  , unsigned  int, const MAKRti::DtString &  , const MAKRti::DtString &  , DtHlaVersionId    )

virtual

callbacks when the federate tracking filter notices a federate join/resign event.

virtual void DtExtendedRtiMsgForwarder::federateResigned ( const MAKRti::DtString &  , const MAKRti::DtString &  , unsigned  int, unsigned  int, const DtInetAddrAndPort &    )

virtual

virtual const DtFederateTrackingFilter* DtExtendedRtiMsgForwarder::fedHandleTrackingFilter ( ) const

inlinevirtual

bool DtExtendedRtiMsgForwarder::flush ( )

inlinevirtual

Send buffered messages.

Returns the status indicating error, flush is complete or incomplete.

References DtUdpMsgSocket::flush(), DtUdpMsgSocket::isOpen(), and myUdpSendSocket.

virtual const DtCharBufferQueue::Buffer* DtExtendedRtiMsgForwarder::getNextMsg ( )

virtual

Get the next message received from the connected sockets.

• Buffer is valid until the next call to getNextMsg()

virtual void DtExtendedRtiMsgForwarder::init ( )

protectedvirtual

Virtual ctor idiom (continues initialization after both base and derived are initialized)

Reimplemented from DtRtiMsgForwarder.

virtual void DtExtendedRtiMsgForwarder::listenToMulticastGroup ( const MAKRti::DtInetAddr &  mcastAddr )

virtual

Listen / drop multicast groups.

virtual DtForwarderPort::DtAddressPortList DtExtendedRtiMsgForwarder::newConnections ( ) const

virtual

Get the list of connections created since last call.

virtual void DtExtendedRtiMsgForwarder::refreshConnectionList ( ) const

protectedvirtual

Get all changes to connections since last call This method is const so that const front-end threads can call it.

• this hides the fact that changes actually occur in a separate thread and the front-end merely reflects back-end state
• ie - the actual state is stored in the back-end and this method IS const with respect to it

virtual void DtExtendedRtiMsgForwarder::removeExecConnectionEstablishedCb ( DtForwarderPort::DtExecAddChangeCb  callback, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::removeExecConnectionLostCb ( DtForwarderPort::DtExecRemovedChangeCb  callback, void *  usr  )

virtual

virtual void DtExtendedRtiMsgForwarder::selectParams ( MAKRti::DtSelectParamWithWrite &  selectParams )

virtual

Get a set of file descriptors to select against for socket notification.

virtual void DtExtendedRtiMsgForwarder::sendBestEffort ( const DtForwarderPort::DtForwarderMsg &  msg )

virtual

Apply registered filters and send message to LAN via UDP socket.

virtual void DtExtendedRtiMsgForwarder::sendByTransport ( const DtForwarderPort::DtForwarderMsg &  msg )

virtual

Check transport metadata and send message to appropriate socket(s)

virtual void DtExtendedRtiMsgForwarder::sendMessageToWan ( const DtRtiMsg &  msg )

virtual

Allow filters to send messages only to the WAN (not back to the LAN) (useful to distributed forwarder mode filters)

virtual void DtExtendedRtiMsgForwarder::sendToAllReliable ( const DtForwarderPort::DtForwarderMsg &  msg )

virtual

Apply registered filters and send message to unfiltered TCP sockets.

virtual void DtExtendedRtiMsgForwarder::tcpSocketAdditionCb ( DtTcpMsgSocket *  sock )

protectedvirtual

Over-ride socket addition/removal callback to track socket list.

Reimplemented from DtRtiMsgForwarder.

virtual void DtExtendedRtiMsgForwarder::tcpSocketRemovalCb ( DtTcpMsgSocket *  sock )

protectedvirtual

Reimplemented from DtRtiMsgForwarder.

virtual void DtExtendedRtiMsgForwarder::updateSocketQueueStatus ( unsigned int  connId, int  connQueueStatus  )

virtual

Member Data Documentation

DtClock DtExtendedRtiMsgForwarder::myClock

protected

Local timer.

std::set< DtAddressAndSockIdPair > DtExtendedRtiMsgForwarder::myConnections

mutableprotected

DtForwarderPort::DtAddressPortList DtExtendedRtiMsgForwarder::myDroppedConnections

mutableprotected

DtForwarderPort::DtFederateAddedCallbackList DtExtendedRtiMsgForwarder::myFederateJoinedCbs

protected

DtForwarderPort::DtFederateRemovedCallbackList DtExtendedRtiMsgForwarder::myFederateResignedCbs

protected

DtFederateTrackingFilter* DtExtendedRtiMsgForwarder::myFedHandleTracker

protected

bool DtExtendedRtiMsgForwarder::myForwardMessagesToParent

protected

Should the local forwarder pass a copy of all messages on to the Parent or simply forward within the local LAN (allows optimization when this is a stand-alone forwarder)

DtCharBufferQueue DtExtendedRtiMsgForwarder::myInMsgQueue

protected

MAKRti::DtTime DtExtendedRtiMsgForwarder::myLastDiscoveryTickTime

protected

Time of last pass for mcast discovery.

std::auto_ptr<DtCharBufferQueue::Buffer> DtExtendedRtiMsgForwarder::myLastReceivedMsg

protected

DtForwarderPort::DtAddressPortList DtExtendedRtiMsgForwarder::myNewConnections

mutableprotected

DtMessageBufferFilter* DtExtendedRtiMsgForwarder::myOutMsgFilter

protected

DtCharBufferQueue DtExtendedRtiMsgForwarder::myOutMsgQueue

protected

DtForwarderPort::DtCallbackList DtExtendedRtiMsgForwarder::mySocketAddedCbs

protected

DtThreadSafeQueue< DtBoolAddressSocketIdPair > DtExtendedRtiMsgForwarder::mySocketListChanges

mutableprotected

DtForwarderPort::DtSocketQueueCallbackList DtExtendedRtiMsgForwarder::mySocketQueueCbs

protected

DtForwarderPort::DtCallbackList DtExtendedRtiMsgForwarder::mySocketRemovedCbs

protected

DtUdpMsgSocket* DtExtendedRtiMsgForwarder::myUdpRcvSocket

protected

DtUdpMsgSocket* DtExtendedRtiMsgForwarder::myUdpSendSocket

protected

Referenced by flush().

const unsigned int DtExtendedRtiMsgForwarder::theForwarderId

static

Address space for connection IDs for this LAN.

---

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

• extendedRtiMsgForwarder.h