MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Protected Attributes
DtRtiAssistantForwarderClient Class Reference

The client connection to the RTI Assistant for the an RTI Forwarder. More...

+ Inheritance diagram for DtRtiAssistantForwarderClient:
+ Collaboration diagram for DtRtiAssistantForwarderClient:

List of all members.

Public Member Functions

 DtRtiAssistantForwarderClient (DtAssistantComponentType type, int port=DtASSISTANT_DEFAULT_PORT)
 Constructor.
virtual ~DtRtiAssistantForwarderClient ()
 Destructor.
virtual void updateForwarderInfo (const MAKRti::DtInetAddr &reliableIpAddr, const MAKRti::DtInetAddr &bestEffortIpAddr, int udpPort, int tcpPort, bool fullCompliance, int forwarderPort, const MAKRti::DtInetAddr &additionalForwarder)
 Updates the forwarder connection info to be sent to the Assistant.
virtual void updateExecConfirmed (bool confirmed, bool fullyCompliant)
 Updates whether or not there is an rtiexec confirmed in order to be sent to the Assistant.
virtual void sendClientInfo ()
 Send forwarder address and port to the Assistant.
virtual void sendFullForwarderInfo (unsigned int numForwarderToForwarderConns, const std::vector< MAKRti::DtString > &forwarderIdentifiers, const std::vector< MAKRti::DtString > &forwarderConnectionHostNames, const std::vector< MAKRti::DtInetAddr > &forwarderConnectionAddrs, const std::vector< int > &forwarderConnectionPorts, unsigned int numForwarderExecConns, unsigned int numForwarderClientConns, const std::vector< MAKRti::DtString > &clientConnectionNames, const std::vector< MAKRti::DtString > &clientConnectionTypeNames, const std::vector< DtString > &clientConnectionProcessNames, const std::vector< DtString > &clientConnectionPIDs, const std::vector< DtString > &clientConnectionCommandArgs, const std::vector< MAKRti::DtString > &clientConnectionHostNames, const std::vector< MAKRti::DtInetAddr > &clientConnectionAddrs, const std::vector< MAKRti::DtString > &clientConnectionFederationNames, const std::vector< int > &clientConnectionHandles, const std::vector< int > &clientConnectionQueueStatus, const std::vector< DtHlaVersionId > &clientHlaVersions)
 Sends information on this forwarder and all of its connected components.
virtual void sendWaitingForForwarders (bool isWaiting, const DtNeededFwConnMap &neededFws)
 Sends information regarding what forwarder connections we are currently waiting for.

Protected Attributes

MAKRti::DtInetAddr myReliableAddr
 The host address for the forwarder.
MAKRti::DtInetAddr myBestEffortAddr
 The best effort address for the forwarder.
int myTcpPort
 The TCP port for the forwarder.
int myUdpPort
 The UDP port for the forwarder.
MAKRti::DtString myHostName
 The host name for the forwarder.
bool myFullCompliance
 Whether full compliance is enabled.
int myForwarderPort
 The port used to connect to other forwarders.
MAKRti::DtInetAddr myAdditionalForwarder
 The IP address of an optional additional forwarder that this forwarder attempted to connect to.
bool myExecConfirmed
 Whether an exec has connected to this forwarder or in the distributed forwarder network.

Detailed Description

The client connection to the RTI Assistant for the an RTI Forwarder.

That RTI forwarder can be a thread of the RtiExec or a stand along Forwarder. DtRtiAssistantForwarderClient manages the client connection of the forwarder to the RTI Assistant. Provides routines to create and send messages to the Assistant.


Constructor & Destructor Documentation

Constructor.

References DtRtiAssistantClient::initialize().

Destructor.


Member Function Documentation

void DtRtiAssistantForwarderClient::sendFullForwarderInfo ( unsigned int  numForwarderToForwarderConns,
const std::vector< MAKRti::DtString > &  forwarderIdentifiers,
const std::vector< MAKRti::DtString > &  forwarderConnectionHostNames,
const std::vector< MAKRti::DtInetAddr > &  forwarderConnectionAddrs,
const std::vector< int > &  forwarderConnectionPorts,
unsigned int  numForwarderExecConns,
unsigned int  numForwarderClientConns,
const std::vector< MAKRti::DtString > &  clientConnectionNames,
const std::vector< MAKRti::DtString > &  clientConnectionTypeNames,
const std::vector< DtString > &  clientConnectionProcessNames,
const std::vector< DtString > &  clientConnectionPIDs,
const std::vector< DtString > &  clientConnectionCommandArgs,
const std::vector< MAKRti::DtString > &  clientConnectionHostNames,
const std::vector< MAKRti::DtInetAddr > &  clientConnectionAddrs,
const std::vector< MAKRti::DtString > &  clientConnectionFederationNames,
const std::vector< int > &  clientConnectionHandles,
const std::vector< int > &  clientConnectionQueueStatus,
const std::vector< DtHlaVersionId > &  clientHlaVersions 
) [virtual]

Sends information on this forwarder and all of its connected components.

References DtAssistantForwarderStateMsgKind, DtRtiAssistantClient::msgFactory(), DtRtiAssistantClient::sendMsg(), and DtAssistantForwarderStateMsg::setAllData().

void DtRtiAssistantForwarderClient::sendWaitingForForwarders ( bool  isWaiting,
const DtNeededFwConnMap neededFws 
) [virtual]
void DtRtiAssistantForwarderClient::updateExecConfirmed ( bool  confirmed,
bool  fullyCompliant 
) [virtual]

Updates whether or not there is an rtiexec confirmed in order to be sent to the Assistant.

Note that this method does not send the data to the assistant, just stores it to be sent when sendClientInfo is called.

References myExecConfirmed, and myFullCompliance.

void DtRtiAssistantForwarderClient::updateForwarderInfo ( const MAKRti::DtInetAddr &  reliableIpAddr,
const MAKRti::DtInetAddr &  bestEffortIpAddr,
int  udpPort,
int  tcpPort,
bool  fullCompliance,
int  forwarderPort,
const MAKRti::DtInetAddr &  additionalForwarder 
) [virtual]

Updates the forwarder connection info to be sent to the Assistant.

Note that this method does not send the data to the assistant, just stores it to be sent when sendClientInfo is called.

Reimplemented in DtRtiAssistantExecClient.

References DtGetLocalHostName(), myAdditionalForwarder, myBestEffortAddr, myForwarderPort, myFullCompliance, myHostName, myReliableAddr, myTcpPort, myUdpPort, and tcpPort.


Member Data Documentation

The IP address of an optional additional forwarder that this forwarder attempted to connect to.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

MAKRti::DtInetAddr DtRtiAssistantForwarderClient::myBestEffortAddr [protected]

The best effort address for the forwarder.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

Whether an exec has connected to this forwarder or in the distributed forwarder network.

Referenced by sendClientInfo(), and updateExecConfirmed().

The port used to connect to other forwarders.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

MAKRti::DtString DtRtiAssistantForwarderClient::myHostName [protected]

The host name for the forwarder.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

MAKRti::DtInetAddr DtRtiAssistantForwarderClient::myReliableAddr [protected]

The host address for the forwarder.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

The TCP port for the forwarder.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().

The UDP port for the forwarder.

Referenced by sendClientInfo(), DtRtiAssistantExecClient::sendClientInfo(), and updateForwarderInfo().


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)