MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
DtRtiForwarderObserverMgr Class Reference
The RTIspy Forwarder Library (forwarder)

The DtRtiForwarderObserverMgr is the class which manages all RTI Forwarder observers. More...

+ Collaboration diagram for DtRtiForwarderObserverMgr:

List of all members.

Public Member Functions

 DtRtiForwarderObserverMgr ()
 Constructor.
virtual ~DtRtiForwarderObserverMgr ()
 Destructor.
virtual void setForwarderNode (DtBoost::shared_ptr< DtForwarderNode > forwarder)
 Sets the forwarder to be observed.
virtual void addObserver (DtBoost::shared_ptr< DtRtiForwarderObserver > observer)
 Add a new RTI Forwarder observer.
virtual void removeObserver (DtBoost::shared_ptr< DtRtiForwarderObserver > observer)
 Remove RTI Forwarder observer.
virtual void removeAllObservers ()
 Remove all RTI Forwarder observers.
virtual void addRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, DtRtiForwarderObserver *observer, bool isMomCallback)
 Add callback for incoming RTI message.
virtual void removeRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, DtRtiForwarderObserver *observer, bool isMomCallback)
 Remove callback for incoming RTI message.
virtual int clientToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
virtual int clientToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
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 &hostName, unsigned int procesId, const MAKRti::DtString &processName, const MAKRti::DtString &commandArgs, DtHlaVersionId hlaVersion)
virtual int clientToForwarderSocketQueueUpdate (unsigned int connId, int connQueueStatus)
virtual void clientToForwarderFederateLost (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &connAddr)
virtual int forwarderToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &connHost, bool fullyCompliant)
virtual int forwarderToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
virtual int clientToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &hostName, bool fullyCompliant)
virtual int clientToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
virtual int forwarderToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
virtual int forwarderToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr)
virtual void waitingForFowrarderConnections (const DtForwarderPort::DtConnAndNameMap &allNeededFws, const DtForwarderPort::DtConnAndNameMap &stillNeededFws)
virtual void notWaitingForFowrarderConnections ()
virtual void addTickCallback (DtTickCbFn fcn, DtRtiForwarderObserver *observer, MAKRti::DtTime interval)
 Add a tick callback function to be called periodically at the given time interval.
virtual void removeTickCallback (DtTickCbFn fcn, DtRtiForwarderObserver *observer)
 Remove tick callback.
virtual unsigned long connectionId () const
 Retrieve information about this node.
virtual const DtInetAddrAndPort & connectionAddr () const
virtual MAKRti::DtString connectionName () const

Static Public Member Functions

static int clientToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for established client<->forwarder connections.
static int clientToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for lost client<->forwarder connections.
static 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 &hostName, unsigned int procesId, const MAKRti::DtString &processName, const MAKRti::DtString &commandArgs, DtHlaVersionId hlaVersion, void *usr)
 Callback for established client<->forwarder connections.
static int clientToForwarderSocketQueueUpdate (unsigned int connId, int connQueueStatus, void *usr)
static void clientToForwarderFederateLost (const MAKRti::DtString &connName, const MAKRti::DtString &connType, unsigned int connID, unsigned int fedHandle, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for lost client<->forwarder connections.
static int forwarderToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &connHost, bool fullyCompliant, void *usr)
 Callback for established forwarder<->forwarder rtiexec connections.
static int forwarderToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for lost forwarder<->forwarder rtiexec connections.
static int clientToForwarderExecConnected (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, const MAKRti::DtString &hostName, bool fullyCompliant, void *usr)
 Callback for established client<->forwarder rtiexec connections.
static int clientToForwarderExecLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for lost client<->forwarder rtiexec connections.
static int forwarderToForwarderConnectionEstablished (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for established forwarder<->forwarder connections.
static int forwarderToForwarderConnectionLost (const MAKRti::DtString &connName, unsigned int connID, const DtInetAddrAndPort &connAddr, void *usr)
 Callback for lost forwarder<->forwarder connections.
static void waitingForFowrarderConnections (const DtForwarderPort::DtConnAndNameMap &allNeededFws, const DtForwarderPort::DtConnAndNameMap &stillNeededFws, void *usr)
 Callback to signal that forwarder is waiting for forwarder<->forwarder connections.
static void notWaitingForFowrarderConnections (void *usr)
 Callback to signal that forwarder is no longer waiting for forwarder<->forwarder connections.

Protected Types

typedef std::set< DtMsgCbInfo > DtMsgCbSet
typedef std::set
< DtTickCallbackInfo > 		DtTickCbSet
typedef std::set
< DtForwarderPortCbInfo > 		DtForwarderPortCbSet
typedef std::list
< DtBoost::shared_ptr
< DtRtiForwarderObserver > > 		DtForwarderObsList

Protected Member Functions

 DtRtiForwarderObserverMgr (const DtRtiForwarderObserverMgr &orig)
 Copy constructor unimplemented.
DtRtiForwarderObserverMgr & operator= (const DtRtiForwarderObserverMgr &orig)
 Assignment unimplemented.

Protected Attributes

DtBoost::shared_ptr
< DtForwarderNode > 		myForwarder
 The RTI Forwarder which is being observed.
DtForwarderObsList myObservers
 List of RTI Forwarder observers.
DtMsgCbSet myMsgCbSet
 Set of all registered message callbacks.
DtTickCbSet myTickCbSet
 Set of all registered tick callbacks.

Detailed Description

The DtRtiForwarderObserverMgr is the class which manages all RTI Forwarder observers.

Member Typedef Documentation

typedef std::list< DtBoost::shared_ptr<DtRtiForwarderObserver> > DtRtiForwarderObserverMgr::DtForwarderObsList [protected]
typedef std::set<DtForwarderPortCbInfo> DtRtiForwarderObserverMgr::DtForwarderPortCbSet [protected]
typedef std::set<DtMsgCbInfo> DtRtiForwarderObserverMgr::DtMsgCbSet [protected]
typedef std::set<DtTickCallbackInfo> DtRtiForwarderObserverMgr::DtTickCbSet [protected]

Constructor & Destructor Documentation

DtRtiForwarderObserverMgr::DtRtiForwarderObserverMgr ( )

Constructor.

DtRtiForwarderObserverMgr::~DtRtiForwarderObserverMgr ( ) [virtual]

Destructor.

References clientToForwarderConnectionEstablished(), clientToForwarderConnectionLost(), clientToForwarderExecConnected(), clientToForwarderExecLost(), clientToForwarderFederateJoined(), clientToForwarderFederateLost(), forwarderToForwarderConnectionEstablished(), forwarderToForwarderConnectionLost(), myForwarder, and removeAllObservers().

DtRtiForwarderObserverMgr::DtRtiForwarderObserverMgr ( const DtRtiForwarderObserverMgr &  orig) [protected]

Copy constructor unimplemented.

Member Function Documentation

void DtRtiForwarderObserverMgr::addObserver ( DtBoost::shared_ptr< DtRtiForwarderObserver >  observer) [virtual]

Add a new RTI Forwarder observer.

References myObservers.

void DtRtiForwarderObserverMgr::addRtiMsgCallback ( DtRtiMsgKind  msgKind,
DtRtiMsgCbMgr::DtCallbackFcn  fcn,
DtRtiForwarderObserver *  observer,
bool  isMomCallback 
) [virtual]

Add callback for incoming RTI message.

Referenced by DtRtiForwarderObserver::addRtiMsgCallback().

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

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

References myForwarder, and myTickCbSet.

Referenced by DtRtiForwarderObserver::addTickCallback().

int DtRtiForwarderObserverMgr::clientToForwarderConnectionEstablished ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for established client<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References myObservers.

int DtRtiForwarderObserverMgr::clientToForwarderConnectionLost ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for lost client<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References myForwarder, and myObservers.

int DtRtiForwarderObserverMgr::clientToForwarderExecConnected ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
const MAKRti::DtString &  hostName,
bool  fullyCompliant,
void *  usr 
) [static]

Callback for established client<->forwarder rtiexec connections.

Referenced by clientToForwarderExecConnected(), setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References clientToForwarderExecConnected(), and myObservers.

int DtRtiForwarderObserverMgr::clientToForwarderExecLost ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for lost client<->forwarder rtiexec connections.

Referenced by clientToForwarderExecLost(), setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References clientToForwarderExecLost(), and myObservers.

void DtRtiForwarderObserverMgr::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 &  hostName,
unsigned int  procesId,
const MAKRti::DtString &  processName,
const MAKRti::DtString &  commandArgs,
DtHlaVersionId  hlaVersion,
void *  usr 
) [static]

Callback for established client<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

void DtRtiForwarderObserverMgr::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 &  hostName,
unsigned int  procesId,
const MAKRti::DtString &  processName,
const MAKRti::DtString &  commandArgs,
DtHlaVersionId  hlaVersion 
) [virtual]

References myObservers.

void DtRtiForwarderObserverMgr::clientToForwarderFederateLost ( const MAKRti::DtString &  connName,
const MAKRti::DtString &  connType,
unsigned int  connID,
unsigned int  fedHandle,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for lost client<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References myForwarder, and myObservers.

int DtRtiForwarderObserverMgr::clientToForwarderSocketQueueUpdate ( unsigned int  connId,
int  connQueueStatus,
void *  usr 
) [static]

Referenced by setForwarderNode().

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

References myObservers.

const DtInetAddrAndPort & DtRtiForwarderObserverMgr::connectionAddr ( ) const [virtual]

References myForwarder.

Referenced by DtForwarderObserverForAssistant::sendForwarderInfoToAssistant().

unsigned long DtRtiForwarderObserverMgr::connectionId ( ) const [virtual]

Retrieve information about this node.

References myForwarder.

Referenced by DtRtiForwarderObserver::connectionId(), and DtForwarderObserverForAssistant::sendForwarderInfoToAssistant().

MAKRti::DtString DtRtiForwarderObserverMgr::connectionName ( ) const [virtual]

References myForwarder.

Referenced by DtForwarderObserverForAssistant::sendForwarderInfoToAssistant().

int DtRtiForwarderObserverMgr::forwarderToForwarderConnectionEstablished ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for established forwarder<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References myObservers.

int DtRtiForwarderObserverMgr::forwarderToForwarderConnectionLost ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for lost forwarder<->forwarder connections.

Referenced by setForwarderNode(), and ~DtRtiForwarderObserverMgr().

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

References myObservers.

int DtRtiForwarderObserverMgr::forwarderToForwarderExecConnected ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
const MAKRti::DtString &  connHost,
bool  fullyCompliant,
void *  usr 
) [static]

Callback for established forwarder<->forwarder rtiexec connections.

Referenced by setForwarderNode().

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

References myObservers.

int DtRtiForwarderObserverMgr::forwarderToForwarderExecLost ( const MAKRti::DtString &  connName,
unsigned int  connID,
const DtInetAddrAndPort &  connAddr,
void *  usr 
) [static]

Callback for lost forwarder<->forwarder rtiexec connections.

Referenced by setForwarderNode().

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

References myObservers.

void DtRtiForwarderObserverMgr::notWaitingForFowrarderConnections ( void *  usr) [static]

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

References notWaitingForFowrarderConnections().

void DtRtiForwarderObserverMgr::notWaitingForFowrarderConnections ( ) [virtual]

References myObservers.

Referenced by notWaitingForFowrarderConnections(), and setForwarderNode().

DtRtiForwarderObserverMgr& DtRtiForwarderObserverMgr::operator= ( const DtRtiForwarderObserverMgr &  orig) [protected]

Assignment unimplemented.

void DtRtiForwarderObserverMgr::removeAllObservers ( ) [virtual]

Remove all RTI Forwarder observers.

References myObservers.

Referenced by ~DtRtiForwarderObserverMgr().

void DtRtiForwarderObserverMgr::removeObserver ( DtBoost::shared_ptr< DtRtiForwarderObserver >  observer) [virtual]

Remove RTI Forwarder observer.

References myObservers.

void DtRtiForwarderObserverMgr::removeRtiMsgCallback ( DtRtiMsgKind  msgKind,
DtRtiMsgCbMgr::DtCallbackFcn  fcn,
DtRtiForwarderObserver *  observer,
bool  isMomCallback 
) [virtual]

Remove callback for incoming RTI message.

Referenced by DtRtiForwarderObserver::removeRtiMsgCallback().

void DtRtiForwarderObserverMgr::removeTickCallback ( DtTickCbFn  fcn,
DtRtiForwarderObserver *  observer 
) [virtual]

Remove tick callback.

References myForwarder, and myTickCbSet.

Referenced by DtRtiForwarderObserver::removeTickCallback().

void DtRtiForwarderObserverMgr::setForwarderNode ( DtBoost::shared_ptr< DtForwarderNode >  forwarder) [virtual]

Sets the forwarder to be observed.

References clientToForwarderConnectionEstablished(), clientToForwarderConnectionLost(), clientToForwarderExecConnected(), clientToForwarderExecLost(), clientToForwarderFederateJoined(), clientToForwarderFederateLost(), clientToForwarderSocketQueueUpdate(), forwarderToForwarderConnectionEstablished(), forwarderToForwarderConnectionLost(), forwarderToForwarderExecConnected(), forwarderToForwarderExecLost(), myForwarder, myObservers, notWaitingForFowrarderConnections(), and waitingForFowrarderConnections().

void DtRtiForwarderObserverMgr::waitingForFowrarderConnections ( const DtForwarderPort::DtConnAndNameMap &  allNeededFws,
const DtForwarderPort::DtConnAndNameMap &  stillNeededFws,
void *  usr 
) [static]

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

Referenced by setForwarderNode().

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

References myObservers.

Member Data Documentation

DtBoost::shared_ptr<DtForwarderNode> DtRtiForwarderObserverMgr::myForwarder [protected]

The RTI Forwarder which is being observed.

Referenced by addTickCallback(), clientToForwarderConnectionLost(), clientToForwarderFederateLost(), connectionAddr(), connectionId(), connectionName(), removeTickCallback(), setForwarderNode(), and ~DtRtiForwarderObserverMgr().

DtMsgCbSet DtRtiForwarderObserverMgr::myMsgCbSet [protected]

Set of all registered message callbacks.

DtForwarderObsList DtRtiForwarderObserverMgr::myObservers [protected]

List of RTI Forwarder observers.

Referenced by addObserver(), clientToForwarderConnectionEstablished(), clientToForwarderConnectionLost(), clientToForwarderExecConnected(), clientToForwarderExecLost(), clientToForwarderFederateJoined(), clientToForwarderFederateLost(), clientToForwarderSocketQueueUpdate(), forwarderToForwarderConnectionEstablished(), forwarderToForwarderConnectionLost(), forwarderToForwarderExecConnected(), forwarderToForwarderExecLost(), notWaitingForFowrarderConnections(), removeAllObservers(), removeObserver(), setForwarderNode(), and waitingForFowrarderConnections().

DtTickCbSet DtRtiForwarderObserverMgr::myTickCbSet [protected]

Set of all registered tick callbacks.

Referenced by addTickCallback(), and removeTickCallback().

The documentation for this class was generated from the following files:
Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)