The DtForwarderPort is an Abstract Base Class which provides the interface to a collection of connections from which messages may be read and to which messages may be sent. More...

Inheritance diagram for DtLanForwarderPort:

Collaboration diagram for DtLanForwarderPort:

Public Member Functions
virtual	~DtLanForwarderPort ()

virtual bool	isReady () const
	Is the Port fully usable and available? More...

virtual DtAddressMsgPair	getNextMsg ()
	Get the next message to forward and the source connection. More...

virtual void	sendByTransport (const DtForwarderMsg &msg) const
	Check transport metadata and send message to appropriate destinations. More...

virtual void	sendToAllReliable (const DtForwarderMsg &msg) const
	Send a message via reliable transport to all available destinations. More...

virtual void	sendToListReliable (const DtForwarderMsg &msg, const DtAddressPortList &destinations) const
	Send a message via reliable transport to the specified list of destinations. More...

virtual bool	flush ()
	Flush any unsent/buffered packets; return true if flush sent data. More...

virtual void	setForwarderId (unsigned long id)
	Set forwarder ID. More...

virtual void	selectParams (MAKRti::DtSelectParamWithWrite &selectParams)
	Add this port's current select() notification set to the passed set. More...

virtual void	updateRoutes ()
	Handle changes to the Routing map. More...

virtual int	checkConnectionStatus (const DtInetAddrAndPort *target=0)
	Test for lost connections - returns true if targeted connection is active or if no target specified returns false if at least one drop detected. More...

virtual void	clearNeededConnections ()
	Clear the list of connections that this forwarder needs to establish. More...

virtual unsigned int	abortPendingConnections ()
	Abort any embryonic connections. More...

unsigned int	pendingConnectionsAborted ()
	Return count of aborted connections. More...

virtual DtAddressPortList	connections () const
	Get the list of all current connections to this port. More...

virtual void	listenToMulticastGroup (const MAKRti::DtInetAddr &mcastAddr)
	Listen / drop multicast groups (LAN-port-only) More...

virtual void	dropMulticastGroup (const MAKRti::DtInetAddr &mcastAddr)
	Listen / drop multicast groups (LAN-port-only) More...

virtual bool	updateFederateConnectionId (unsigned long orig, unsigned long final)
	Update locally connected federate connection ID (LAN-port-only) More...

virtual const DtFederateTrackingFilter *	fedTrackingFilter () const
	return federateTrackingFilter More...

virtual bool	populateConnectionInformation (unsigned int &numForwarderClientConns, unsigned int &numForwarderExecConns, std::vector< MAKRti::DtString > &clientConnectionHostNames, std::vector< MAKRti::DtInetAddr > &clientConnectionAddrs) const

Public Member Functions inherited from DtForwarderPort
virtual	~DtForwarderPort ()

virtual bool	isOk () const
	Is the Port still alive? More...

virtual void	addConnectionEstablishedCb (DtConnectionAddRemoveCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	removeConnectionEstablishedCb (DtConnectionAddRemoveCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	addConnectionLostCb (DtConnectionAddRemoveCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	removeConnectionLostCb (DtConnectionAddRemoveCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	addConnectionChangedCb (DtConnectionChangeCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	removeConnectionChangedCb (DtConnectionChangeCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	addReconnectBegun (DtConnectionReconnectBegunCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	removeReconnectBegun (DtConnectionReconnectBegunCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	addReconnectComplete (DtConnectionReconnectCompleteCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	removeReconnectComplete (DtConnectionReconnectCompleteCb callback, void *usr)
	Register/Unregister callback for addition/removal/change of connections. More...

virtual void	addForwarderPortReadyCb (DtPortReadyCb callback, void *usr)
	Register/Unregister callback for event - forwarder port becomes ready. More...

virtual void	removeForwarderPortReadyCb (DtPortReadyCb callback, void *usr)
	Register/Unregister callback for event - forwarder port becomes ready. More...

virtual void	addFederateJoinedCb (DtFederateAddedCb callback, void *usr)
	Register/Unregister callback for event - federate join/resign. More...

virtual void	removeFederateJoinedCb (DtFederateAddedCb callback, void *usr)
	Register/Unregister callback for event - federate join/resign. More...

virtual void	addFederateResignedCb (DtFederateRemovedCb callback, void *usr)
	Register/Unregister callback for event - federate join/resign. More...

virtual void	removeFederateResignedCb (DtFederateRemovedCb callback, void *usr)
	Register/Unregister callback for event - federate join/resign. More...

virtual void	addSocketQueueCb (DtSocketQueueCb callback, void *usr)
	Register/Unregister callback for event - socket queue status changes. More...

virtual void	removeSocketQueueCb (DtSocketQueueCb callback, void *usr)
	Register/Unregister callback for event - socket queue status changes. More...

virtual void	addWaitingForForwarderConnectionsCb (DtWaitingForFwsCb callback, void *usr)
	Register/Unregister callback for event - entrance/exit the "waiting for forwarder connections" state. More...

virtual void	removeWaitingForForwarderConnectionsCb (DtWaitingForFwsCb callback, void *usr)
	Register/Unregister callback for event - entrance/exit the "waiting for forwarder connections" state. More...

virtual void	addNotWaitingForForwarderConnectionsCb (DtNotWaitingForFwsCb callback, void *usr)
	Register/Unregister callback for event - entrance/exit the "waiting for forwarder connections" state. More...

virtual void	removeNotWaitingForForwarderConnectionsCb (DtNotWaitingForFwsCb callback, void *usr)
	Register/Unregister callback for event - entrance/exit the "waiting for forwarder connections" state. More...

virtual void	addExecConnectionEstablishedCb (DtExecAddChangeCb callback, void *usr)
	Register/Unregister callback for event - exec connected/disconnected. More...

virtual void	removeExecConnectionEstablishedCb (DtExecAddChangeCb callback, void *usr)
	Register/Unregister callback for event - exec connected/disconnected. More...

virtual void	addExecDisconnectedCb (DtExecRemovedChangeCb callback, void *usr)
	Register/Unregister callback for event - exec connected/disconnected. More...

virtual void	removeExecDisconnectedCb (DtExecRemovedChangeCb callback, void *usr)
	Register/Unregister callback for event - exec connected/disconnected. More...

virtual int	execConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &addr, const MAKRti::DtString &hostName, bool fullyCompliant)
	Called when the exec connects/disconnects. More...

virtual int	execDisconnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &addr)
	Called when the exec connects/disconnects. More...

Static Public Member Functions
static DtForwarderPort *	create (const DtRIDParameters *params, const std::shared_ptr< DtRouteMap > routes, const MAKRti::DtInetAddr &host, int forwarderPort, const MAKRti::DtInetEndpoint &forwardertoConnectTo)
	Creates an instance of a DtLanForwarderPort. More...

static void	setCreatorFunction (DtForwarderPortCreatorFcn creator)
	Call this function to set an alternate creator function With this function, users can replace this DtLanForwarderPort with their own derived class. More...

Static Public Member Functions inherited from DtForwarderPort
static void	printAddressMessage (const DtAddressMsgPair &addrMsg, MAKRti::DtOutputStream &outStream=MAKRti::DtVerbose)

static void	printForwarderMessage (const DtForwarderMsg &frwdrMsg, MAKRti::DtOutputStream &outStream=MAKRti::DtVerbose)

static void	printMessage (const caddr_t msg, MAKRti::DtOutputStream &outStream=MAKRti::DtVerbose)

Protected Member Functions
	DtLanForwarderPort (const DtRIDParameters *params, std::shared_ptr< DtRouteMap > routes, const MAKRti::DtInetAddr &host, int forwarderPort, const MAKRti::DtInetEndpoint &forwardertoConnectTo)
	Base Ctor - called by default creator. More...

	DtLanForwarderPort ()
	Default Ctor, Copy Ctor, Assignment - unimplemented. More...

	DtLanForwarderPort (const DtLanForwarderPort &orig)

DtLanForwarderPort &	operator= (const DtLanForwarderPort &orig)

Protected Member Functions inherited from DtForwarderPort
	DtForwarderPort (const DtRIDParameters *params, std::shared_ptr< DtRouteMap > routes, MAKRti::DtInetAddr host, int forwarderPort, MAKRti::DtInetEndpoint addnlConnection)

virtual void	forwarderNodeIsReady (unsigned long id)
	Called when the forwarder port is known and node becomes ready. More...

virtual int	socketQueueStatus (unsigned int connId, int connQueueStatus)
	Called when the socket queue status changes. More...

virtual void	waitingForForwarderConnections (const DtConnAndNameMap &allNeededFws, const DtConnAndNameMap &stillNeededFws)
	Specifies that this port is waiting for other forwarder connections. More...

virtual void	notWaitingForForwarderConnections ()
	Called when exiting from the waiting for forwarder connections state. More...

virtual int	connectionEstablished (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const std::pair< DtInetAddrAndPort, DtInetAddrAndPort > &addr)
	Call when connection is added/removed/changed Invokes callbacks registered for this event. More...

virtual int	connectionLost (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const std::pair< DtInetAddrAndPort, DtInetAddrAndPort > &addr)
	Call when connection is added/removed/changed Invokes callbacks registered for this event. More...

virtual int	connectionChanged (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int oldConnID, unsigned int newConnID, const DtInetAddrAndPort &addr)
	Call when connection is added/removed/changed Invokes callbacks registered for this event. More...

int	reconnectBegun (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const DtInetAddrAndPort &addr)
	Call when connection is added/removed/changed Invokes callbacks registered for this event. More...

int	reconnectComplete (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const DtInetAddrAndPort &addr, bool wasSuccessful)
	Call when connection is added/removed/changed Invokes callbacks registered for this event. More...

virtual void	federateResigned (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &addr)
	Called when the federate joins/resigns. More...

virtual void	federateJoined (const MAKRti::DtString &connName, const MAKRti::DtString &connType, const MAKRti::DtString &federationName, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &addr, const MAKRti::DtString &hostName, unsigned int processId, const MAKRti::DtString &processName, const MAKRti::DtString &commandArgs, DtHlaVersionId hlaVersion)
	Called when the federate joins/resigns. More...

Protected Attributes
const DtRIDParameters *	myParams

DtExtendedRtiMsgForwarder *	myForwarder

bool	myIsReady

Protected Attributes inherited from DtForwarderPort
const DtRIDParameters *	myParams

std::shared_ptr< DtRouteMap >	myRoutes

const MAKRti::DtInetAddr	myAddress

bool	myOk

int	myPortToUse

MAKRti::DtInetEndpoint	myAdditionalAddrToConnectTo

DtConnectionAddRemoveCallbackList	myConnectionEstablishedCbs

DtConnectionAddRemoveCallbackList	myConnectionLostCbs

DtConnectionReconnectBegunCallbackList	myReconnectBegunCbs

DtConnectionReconnectCompleteCallbackList	myReconnectCompleteCbs

DtConnectionChangeCallbackList	myConnectionChangedCbs

DtFederateAddedCallbackList	myFederateJoinedCbs

DtFederateRemovedCallbackList	myFederateResignedCbs

DtPortReadyCallbackList	myPortReadyCbs

DtExecAddedCallbackList	myExecConnectedCbs

DtExecRemovedCallbackList	myExecDisconnectedCbs

DtSocketQueueCallbackList	mySocketQueueCbs

DtWaitingForFwsCallbackList	myWaitingForFwsCbs

DtNotWaitingForFwsCallbackList	myNotWaitingForFwsCbs

Static Protected Attributes
static DtForwarderPortCreatorFcn	theCreator

Additional Inherited Members
Public Types inherited from DtForwarderPort
typedef DtForwarderPort (	DtForwarderPortCreatorFcn )(const DtRIDParameters *, const std::shared_ptr< DtRouteMap >, const MAKRti::DtInetAddr &, int, const MAKRti::DtInetEndpoint &)
	DtForwarderPort creator signature. More...

typedef DtRouteMap::DtAddressPortList	DtAddressPortList

typedef DtRouteMap::DtAddressList	DtAddressList

typedef DtRouteMap::DtInterfaceAddrSet	DtInterfaceAddrSet

typedef std::vector < DtTcpMsgSocket * >	DtSocketList

typedef std::set < DtTcpMsgSocket * >	DtSocketSet

typedef std::pair < DtInetAddrAndPort, DtForwarderMsg >	DtAddressMsgPair

typedef std::pair < DtTcpMsgSocket *, DtForwarderMsg >	DtSockMsgPair

typedef std::map < DtInetAddrAndPort, DtTcpMsgSocket * >	DtAddrToConnMap

typedef std::map < DtInetAddrAndPort, MAKRti::DtString >	DtConnAndNameMap

typedef int(*	DtConnectionAddRemoveCb )(const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, const std::pair< DtInetAddrAndPort, DtInetAddrAndPort > &, void *)

typedef int(*	DtConnectionReconnectBegunCb )(const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, const DtInetAddrAndPort &, void *)

typedef int(*	DtConnectionReconnectCompleteCb )(const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, const DtInetAddrAndPort &, bool, void *)

typedef int(*	DtConnectionChangeCb )(const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, unsigned int, const DtInetAddrAndPort &, void *)

typedef void(*	DtFederateAddedCb )(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, void *)

typedef void(*	DtFederateRemovedCb )(const MAKRti::DtString &, const MAKRti::DtString &, unsigned int, unsigned int, const DtInetAddrAndPort &, void *)

typedef void(*	DtPortReadyCb )(unsigned long, void *)

typedef int(*	DtExecAddChangeCb )(const MAKRti::DtString &, unsigned int, const DtInetAddrAndPort &, const MAKRti::DtString &, bool, void *)

typedef int(*	DtExecRemovedChangeCb )(const MAKRti::DtString &, unsigned int, const DtInetAddrAndPort &, void *)

typedef int(*	DtFederationShadowAddChangeCb )(unsigned int, unsigned int, const MAKRti::DtString &, void *)

typedef int(*	DtFederationShadowRemovedChangeCb )(unsigned int, unsigned int, const MAKRti::DtString &, void *)

typedef int(*	DtSocketQueueCb )(unsigned int, int, void *)

typedef void(*	DtWaitingForFwsCb )(const DtConnAndNameMap &, const DtConnAndNameMap &, void *)

typedef void(*	DtNotWaitingForFwsCb )(void *)

typedef std::vector< std::pair < DtConnectionAddRemoveCb, void * > >	DtConnectionAddRemoveCallbackList

typedef std::vector< std::pair < DtConnectionReconnectBegunCb, void * > >	DtConnectionReconnectBegunCallbackList

typedef std::vector< std::pair < DtConnectionReconnectCompleteCb, void * > >	DtConnectionReconnectCompleteCallbackList

typedef std::vector< std::pair < DtConnectionChangeCb, void * > >	DtConnectionChangeCallbackList

typedef std::vector< std::pair < DtFederateAddedCb, void * > >	DtFederateAddedCallbackList

typedef std::vector< std::pair < DtFederateRemovedCb, void * > >	DtFederateRemovedCallbackList

typedef std::vector< std::pair < DtPortReadyCb, void * > >	DtPortReadyCallbackList

typedef std::vector< std::pair < DtExecAddChangeCb, void * > >	DtExecAddedCallbackList

typedef std::vector< std::pair < DtExecRemovedChangeCb, void * > >	DtExecRemovedCallbackList

typedef std::vector< std::pair < DtFederationShadowAddChangeCb, void * > >	DtFederationShadowAddedCallbackList

typedef std::vector< std::pair < DtFederationShadowRemovedChangeCb, void * > >	DtFederationShadowRemovedCallbackList

typedef std::vector< std::pair < DtSocketQueueCb, void * > >	DtSocketQueueCallbackList

typedef std::vector< std::pair < DtWaitingForFwsCb, void * > >	DtWaitingForFwsCallbackList

typedef std::vector< std::pair < DtNotWaitingForFwsCb, void * > >	DtNotWaitingForFwsCallbackList

Static Protected Member Functions inherited from DtForwarderPort
static int	socketQueueStatus (unsigned int connId, int connQueueStatus, void *usr)
	Callback function registered to be called when socket queue status changes. More...

static void	forwarderNodeIsReady (unsigned long id, void *usr)
	Callback function registered to be called when forwarder node is ready (port is known) More...

static int	connectionEstablished (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const std::pair< DtInetAddrAndPort, DtInetAddrAndPort > &addr, void *usr)
	Callback function registered to be called when connection is added/removed/changed. More...

static int	connectionLost (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int connID, const std::pair< DtInetAddrAndPort, DtInetAddrAndPort > &addr, void *usr)
	Callback function registered to be called when connection is added/removed/changed. More...

static int	connectionChanged (const MAKRti::DtString &connName, const MAKRti::DtString &hostName, unsigned int oldConnID, unsigned int newConnID, const DtInetAddrAndPort &addr, void *usr)
	Callback function registered to be called when connection is added/removed/changed. More...

static void	federateJoined (const MAKRti::DtString &connName, const MAKRti::DtString &connType, const MAKRti::DtString &federationName, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &addr, const MAKRti::DtString &hostName, unsigned int processId, const MAKRti::DtString &processName, const MAKRti::DtString &commandArgs, DtHlaVersionId hlaVersion, void *usr)
	Callback function registered to be called when federate joins/resigns. More...

static void	federateResigned (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &addr, void *usr)
	Callback function registered to be called when federate joins/resigns. More...

static int	execConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &addr, const MAKRti::DtString &hostName, bool fullyCompliant, void *usr)
	Callback function registered to be called when exec connects/disconnects. More...

static int	execDisconnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &addr, void *usr)
	Callback function registered to be called when exec connects/disconnects. More...

Detailed Description

The DtForwarderPort is an Abstract Base Class which provides the interface to a collection of connections from which messages may be read and to which messages may be sent.

Constructor & Destructor Documentation

DtLanForwarderPort::DtLanForwarderPort	(	const DtRIDParameters *	params,
		std::shared_ptr< DtRouteMap >	routes,
		const MAKRti::DtInetAddr &	host,
		int	forwarderPort,
		const MAKRti::DtInetEndpoint &	forwardertoConnectTo
	)

protected

Base Ctor - called by default creator.

virtual DtLanForwarderPort::~DtLanForwarderPort ( )

virtual

DtLanForwarderPort::DtLanForwarderPort ( )

protected

Default Ctor, Copy Ctor, Assignment - unimplemented.

DtLanForwarderPort::DtLanForwarderPort ( const DtLanForwarderPort & orig )

protected

Member Function Documentation

virtual unsigned int DtLanForwarderPort::abortPendingConnections ( )

virtual

Abort any embryonic connections.

Since LAN port does not initiate connections it cannot abort them either, so this method always returns 0

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation