![]() |
MAK RTIspy API Documentation for HLA Evolved
|
The DtAssistantInfoMsg defines a wrapper for the RTI Assistant information message used by the Assistants to share settings and known rtiexec and forwarder information with one another. More...
Inheritance diagram for DtAssistantInfoMsg:
Collaboration diagram for DtAssistantInfoMsg:Public Member Functions | |
| DtAssistantInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtAssistantInfoMsg (const DtNetAssistantInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantInfoMsg () |
| Destructor. | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | setRtiexecsAndForwarders (const DtRtiConnectionAndConfiguration &rtiexecsAndForwarders) |
| Set/Get rtiexec and forwarder information. | |
| virtual void | getRtiexecsAndForwarders (DtRtiConnectionAndConfiguration &rtiexecsAndForwarders, const MAKRti::DtInetAddr &interfaceReceivedOn) const |
| virtual bool | isRemoval () const |
| Get/Set whether the message is indicating the removal of the specified rtiexecs and license servers. | |
| virtual void | setRemoval (bool val) |
| virtual bool | remoteCmdsAccepted () const |
| Get/Set whether the sending assistant is accepting remote commands (e.g. | |
| virtual void | setRemoteCmdsAccepted (bool val) |
| virtual unsigned int | assistantInfoMemoryPeriod () const |
| Get / Set the assistant information memory period. | |
| virtual void | setAssistantInfoMemoryPeriod (unsigned int interval) |
| virtual void | printData () const |
| Print the data section. | |
Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. | |
| virtual DtNetAssistantMsgHeader * | netHeader () const |
| Get header of network representation. | |
| virtual int | version () const |
| Return the message version. | |
| virtual bool | isValidVersion () const |
| Returns bool: message version is valid? | |
| virtual DtAssistantMsgKind | msgKind () const |
| Get the message kind. | |
| virtual void | print () const |
| Printing functions. | |
| virtual void | printHeader () const |
| virtual bool | isOk () const |
| Message is good? | |
| bool | isAssistantToAssistantMessage () const |
| Returns whether or not this message contains source/destination information included in messages sent between assistants. | |
| virtual MAKRti::DtInetAddr | sourceAddr () const |
| Get/Set the IP address of the source of this message. | |
| virtual void | setSourceAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | sourceId () const |
| Get/Set the ID of the source of this message. | |
| virtual void | setSourceId (int id) |
| virtual MAKRti::DtString | sourceHost () const |
| Get/Set the host name of the source of this message. | |
| virtual void | setSourceHost (const MAKRti::DtString &addr) |
| virtual MAKRti::DtInetAddr | destAddr () const |
| Get/Set the IP address of the destination of this message. | |
| virtual void | setDestAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | destId () const |
| Get/Set the ID of the destination of this message. | |
| virtual void | setDestId (int id) |
| virtual int | compId () const |
| Get/Set the related component's connection ID. | |
| virtual void | setCompId (int compId) |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| static void | addCallback (DtRtiAssistantPeer *conn, DtAssistantInfoCb cb, void *usr) |
| Adds or removes a callback with the given Assistant peer for this message type. | |
| static void | removeCallback (DtRtiAssistantPeer *conn, DtAssistantInfoCb cb, void *usr) |
Static Public Member Functions inherited from DtAssistantMsg | |
| static const char * | kindToString (DtAssistantMsgKind kind) |
| Returns the name of the message, by kind enumeration. | |
Protected Member Functions | |
| virtual DtNetAssistantInfoMsg * | netAssistantInfoMsg () |
| The network representation for the message. | |
| virtual const DtNetAssistantInfoMsg * | netAssistantInfoMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantInfoMsg message. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
| virtual void | setRtiexecForwarderCount (unsigned long count) |
| Set/Get number of rtiexecs/forwarders included in message. | |
| virtual unsigned long | rtiexecForwarderCount () const |
| virtual const DtNetU128 * | reliableAddrsPtr () const |
| Return pointer to location of rtiexec/forwarder reliable addresses in message. | |
| virtual DtNetU128 * | reliableAddrsPtr () |
| virtual const DtNetU128 * | bestEffortAddrsPtr () const |
| Return pointer to location of rtiexec/forwarder best effort addresses in message. | |
| virtual DtNetU128 * | bestEffortAddrsPtr () |
| virtual const DtNetU32 * | addressFamiliesPtr () const |
| Return pointer to location of address families in message. | |
| virtual DtNetU32 * | addressFamiliesPtr () |
| virtual const DtNetU32 * | rtiexecCompIdsPtr () const |
| Return pointer to location of rtiexec component IDs in message. | |
| virtual DtNetU32 * | rtiexecCompIdsPtr () |
| virtual const DtNetU32 * | forwarderCompIdsPtr () const |
| Return pointer to location of forwarder component IDs in message. | |
| virtual DtNetU32 * | forwarderCompIdsPtr () |
| virtual const DtNetU16 * | tcpPortsPtr () const |
| Return pointer to location of rtiexec/forwarder TCP ports in message. | |
| virtual DtNetU16 * | tcpPortsPtr () |
| virtual const DtNetU16 * | udpPortsPtr () const |
| Return pointer to location of rtiexec/forwarder UDP ports in message. | |
| virtual DtNetU16 * | udpPortsPtr () |
| virtual const DtNetU16 * | forwarderPortsPtr () const |
| Return pointer to location of forwarder-to-forwarder ports in the message. | |
| virtual DtNetU16 * | forwarderPortsPtr () |
| virtual const DtNetU8 * | fullCompliancePtr () const |
| Return pointer to location of rtiexec/forwarder full compliance settings in message. | |
| virtual DtNetU8 * | fullCompliancePtr () |
| virtual const DtNetU8 * | rtiexecForwarderFlagPtr () const |
| Return pointer to location of flags which indicate if each included rtiexec/forwarder is an rtiexec, forwarder, or both. | |
| virtual DtNetU8 * | rtiexecForwarderFlagPtr () |
| virtual void | setRtiexecForwarderNamesSize (unsigned long size) |
| Set/Get rtiexec/forwarder connection names text size. | |
| virtual unsigned long | rtiexecForwarderNamesSize () const |
| virtual const char * | rtiexecForwarderNamesPtr () const |
| Return pointer to rtiexec/forwarder conn names location in msg. | |
| virtual char * | rtiexecForwarderNamesPtr () |
| virtual void | setHostNamesSize (unsigned long size) |
| Set/Get rtiexec/forwarder host names text size. | |
| virtual unsigned long | hostNamesSize () const |
| virtual const char * | hostNamesPtr () const |
| Return pointer to rtiexec/forwarder host names location in msg. | |
| virtual char * | hostNamesPtr () |
| virtual void | setOwnerHostSize (unsigned size) |
| Set/Get owning host names text size. | |
| virtual unsigned | ownerHostSize () const |
| virtual const char * | ownerHostsPtr () const |
| Return pointer to host names of the machines that own the conns. | |
| virtual char * | ownerHostsPtr () |
Protected Member Functions inherited from DtAssistantMsg | |
| DtAssistantMsg () | |
| Constructor. | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. | |
| void | initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. | |
| void | initAssistantMsg (const void *initial, int size, DtBufferPtr buffer) |
| void | initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer) |
| virtual void | adjustBytes (int offset, int numBytes) |
| Adjust numBytes bytes at the indicated offset in the net rep. | |
| virtual void | adjustBytes (void *address, int numBytes) |
| Adjust the numBytes starting at the indicated address. | |
| virtual void | resizeForSrcDestInfo () |
| Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. | |
| virtual const DtNetAssistantSrcDestInfo * | srcDestInfoPtr () const |
| Return pointer to source/destination information in the message. | |
| virtual DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| virtual void | setSourceHostSize (unsigned long size) |
| Set/Get source host name text size. | |
| virtual unsigned long | sourceHostSize () const |
| virtual const char * | sourceHostPtr () const |
| Return pointer to source host name in message. | |
| virtual char * | sourceHostPtr () |
Protected Attributes | |
| std::map< DtRtiConnectionInfo, DtRtiConnectionConfigurationInfo > | myConfigurationsByConnectionMap |
Static Protected Attributes | |
| static const unsigned | theRtiexecFlag = 0x1 |
| Flag indicating that an entry is an rtiexec. | |
| static const unsigned | theForwarderFlag = 0x2 |
| Flag indicating that an entry is a forwarder. | |
| static const unsigned | theForwarderHasRtiexecFlag = 0x4 |
| Flag indicating that, if entry is for a forwarder, the forwarder is also aware of an rtiexec in its network. | |
The DtAssistantInfoMsg defines a wrapper for the RTI Assistant information message used by the Assistants to share settings and known rtiexec and forwarder information with one another.
| DtAssistantInfoMsg::DtAssistantInfoMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().
| DtAssistantInfoMsg::DtAssistantInfoMsg | ( | const DtNetAssistantInfoMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
References DtNetAssistantInfoMsg::header, and DtAssistantMsg::initAssistantMsg().
|
virtual |
Destructor.
|
static |
Adds or removes a callback with the given Assistant peer for this message type.
References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantInfoMsgKind.
Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().
|
protectedvirtual |
Return pointer to location of address families in message.
References bestEffortAddrsPtr(), and rtiexecForwarderCount().
Referenced by getRtiexecsAndForwarders(), rtiexecCompIdsPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References bestEffortAddrsPtr(), and rtiexecForwarderCount().
|
virtual |
Get / Set the assistant information memory period.
References DtNetAssistantInfoMsg::assistantInfoMemoryPeriod, and netAssistantInfoMsg().
Referenced by DtAssistantConnectionInfoMgr::processInfoMsg().
|
protectedvirtual |
Return pointer to location of rtiexec/forwarder best effort addresses in message.
References reliableAddrsPtr(), and rtiexecForwarderCount().
Referenced by addressFamiliesPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References reliableAddrsPtr(), and rtiexecForwarderCount().
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantInfoMsg(), and netAssistantInfoMsg().
|
static |
Creators.
References DtAssistantInfoMsg().
|
static |
References DtAssistantInfoMsg().
|
protectedvirtual |
Return pointer to location of forwarder component IDs in message.
References rtiexecCompIdsPtr(), and rtiexecForwarderCount().
Referenced by getRtiexecsAndForwarders(), setRtiexecsAndForwarders(), and udpPortsPtr().
|
protectedvirtual |
References rtiexecCompIdsPtr(), and rtiexecForwarderCount().
|
protectedvirtual |
Return pointer to location of forwarder-to-forwarder ports in the message.
References rtiexecForwarderCount(), and tcpPortsPtr().
Referenced by fullCompliancePtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References rtiexecForwarderCount(), and tcpPortsPtr().
|
protectedvirtual |
Return pointer to location of rtiexec/forwarder full compliance settings in message.
References forwarderPortsPtr(), and rtiexecForwarderCount().
Referenced by getRtiexecsAndForwarders(), rtiexecForwarderFlagPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References forwarderPortsPtr(), and rtiexecForwarderCount().
|
virtual |
References DtRtiConnectionAndConfiguration::addConfiguration(), DtRtiConnectionAndConfiguration::addConnection(), addressFamiliesPtr(), bestEffortAddrsPtr(), DtRtiAssociatedConnectionData::DtConnectionForwarderVerified, DtRtiAssociatedConnectionData::DtConnectionVerified, forwarderCompIdsPtr(), forwarderPortsPtr(), fullCompliancePtr(), hostNamesPtr(), ownerHostsPtr(), reliableAddrsPtr(), rtiexecCompIdsPtr(), rtiexecForwarderCount(), rtiexecForwarderFlagPtr(), rtiexecForwarderNamesPtr(), DtRtiConnectionAndConfiguration::setConnectionConfigMapping(), tcpPort, tcpPortsPtr(), theForwarderFlag, theForwarderHasRtiexecFlag, theRtiexecFlag, and udpPortsPtr().
Referenced by DtAssistantConnectionInfoMgr::processInfoMsg().
|
protectedvirtual |
Return pointer to rtiexec/forwarder host names location in msg.
References rtiexecForwarderNamesPtr(), and rtiexecForwarderNamesSize().
Referenced by getRtiexecsAndForwarders(), ownerHostsPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References rtiexecForwarderNamesPtr(), and rtiexecForwarderNamesSize().
|
protectedvirtual |
References DtNetAssistantInfoMsg::hostNamesSize, and netAssistantInfoMsg().
Referenced by ownerHostsPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
Returns the kind of a DtAssistantInfoMsg message.
Implements DtAssistantMsg.
References DtAssistantInfoMsgKind.
Referenced by DtAssistantInfoMsg().
|
virtual |
Get/Set whether the message is indicating the removal of the specified rtiexecs and license servers.
If not, it is for addition.
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::removal.
Referenced by DtAssistantConnectionInfoMgr::processInfoMsg().
|
protectedvirtual |
Returns minimum size of a message, including header.
Referenced by DtAssistantInfoMsg().
|
protectedvirtual |
The network representation for the message.
Referenced by assistantInfoMemoryPeriod(), clone(), hostNamesSize(), isRemoval(), ownerHostSize(), reliableAddrsPtr(), remoteCmdsAccepted(), rtiexecForwarderCount(), rtiexecForwarderNamesSize(), setAssistantInfoMemoryPeriod(), setHostNamesSize(), setOwnerHostSize(), setRemoteCmdsAccepted(), setRemoval(), setRtiexecForwarderCount(), and setRtiexecForwarderNamesSize().
|
protectedvirtual |
|
protectedvirtual |
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::ownerHostSize.
Referenced by setRtiexecsAndForwarders().
|
protectedvirtual |
Return pointer to host names of the machines that own the conns.
References hostNamesPtr(), and hostNamesSize().
Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References hostNamesPtr(), and hostNamesSize().
|
virtual |
Print the data section.
Reimplemented from DtAssistantMsg.
|
protectedvirtual |
Return pointer to location of rtiexec/forwarder reliable addresses in message.
References netAssistantInfoMsg().
Referenced by bestEffortAddrsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References netAssistantInfoMsg().
|
virtual |
Get/Set whether the sending assistant is accepting remote commands (e.g.
starting & shutding down rtiexecs).
References DtNetAssistantInfoMsg::acceptsRemoteCmds, and netAssistantInfoMsg().
Referenced by DtAssistantConnectionInfoMgr::processInfoMsg().
|
static |
References DtAssistantInfoMsgKind, and DtRtiAssistantPeer::removeMsgCallback().
Referenced by DtAssistantConnectionInfoMgr::~DtAssistantConnectionInfoMgr().
|
protectedvirtual |
Return pointer to location of rtiexec component IDs in message.
References addressFamiliesPtr(), and rtiexecForwarderCount().
Referenced by forwarderCompIdsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References addressFamiliesPtr(), and rtiexecForwarderCount().
|
protectedvirtual |
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderCount.
Referenced by addressFamiliesPtr(), bestEffortAddrsPtr(), forwarderCompIdsPtr(), forwarderPortsPtr(), fullCompliancePtr(), getRtiexecsAndForwarders(), rtiexecCompIdsPtr(), rtiexecForwarderFlagPtr(), rtiexecForwarderNamesPtr(), setRtiexecsAndForwarders(), tcpPortsPtr(), and udpPortsPtr().
|
protectedvirtual |
Return pointer to location of flags which indicate if each included rtiexec/forwarder is an rtiexec, forwarder, or both.
References fullCompliancePtr(), and rtiexecForwarderCount().
Referenced by getRtiexecsAndForwarders(), rtiexecForwarderNamesPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References fullCompliancePtr(), and rtiexecForwarderCount().
|
protectedvirtual |
Return pointer to rtiexec/forwarder conn names location in msg.
References rtiexecForwarderCount(), and rtiexecForwarderFlagPtr().
Referenced by getRtiexecsAndForwarders(), hostNamesPtr(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References rtiexecForwarderCount(), and rtiexecForwarderFlagPtr().
|
protectedvirtual |
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderNamesSize.
Referenced by hostNamesPtr(), and setRtiexecsAndForwarders().
|
virtual |
References DtNetAssistantInfoMsg::assistantInfoMemoryPeriod, and netAssistantInfoMsg().
Referenced by DtRtiAssistantPeer::sendInfoMsg().
|
protectedvirtual |
Set/Get rtiexec/forwarder host names text size.
References DtNetAssistantInfoMsg::hostNamesSize, and netAssistantInfoMsg().
Referenced by setRtiexecsAndForwarders().
|
protectedvirtual |
Set/Get owning host names text size.
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::ownerHostSize.
Referenced by setRtiexecsAndForwarders().
|
virtual |
References DtNetAssistantInfoMsg::acceptsRemoteCmds, and netAssistantInfoMsg().
Referenced by DtRtiAssistantPeer::sendInfoMsg().
|
virtual |
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::removal.
Referenced by DtRtiAssistantPeer::sendInfoMsg().
|
protectedvirtual |
Set/Get number of rtiexecs/forwarders included in message.
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderCount.
Referenced by setRtiexecsAndForwarders().
|
protectedvirtual |
Set/Get rtiexec/forwarder connection names text size.
References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderNamesSize.
Referenced by setRtiexecsAndForwarders().
|
virtual |
Set/Get rtiexec and forwarder information.
References addressFamiliesPtr(), bestEffortAddrsPtr(), DtRtiConnectionAndConfiguration::connections(), DtRtiConnectionAndConfiguration::findConfigMapping(), forwarderCompIdsPtr(), forwarderPortsPtr(), fullCompliancePtr(), hostNamesPtr(), hostNamesSize(), rti1516e::insertBytes(), ownerHostSize(), ownerHostsPtr(), reliableAddrsPtr(), rtiexecCompIdsPtr(), rtiexecForwarderCount(), rtiexecForwarderFlagPtr(), rtiexecForwarderNamesPtr(), rtiexecForwarderNamesSize(), setHostNamesSize(), setOwnerHostSize(), setRtiexecForwarderCount(), setRtiexecForwarderNamesSize(), DtRtiConnectionAndConfiguration::size(), tcpPortsPtr(), theForwarderFlag, theForwarderHasRtiexecFlag, theRtiexecFlag, and udpPortsPtr().
Referenced by DtRtiAssistantPeer::sendInfoMsg().
|
protectedvirtual |
Return pointer to location of rtiexec/forwarder TCP ports in message.
References rtiexecForwarderCount(), and udpPortsPtr().
Referenced by forwarderPortsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
protectedvirtual |
References rtiexecForwarderCount(), and udpPortsPtr().
|
protectedvirtual |
Return pointer to location of rtiexec/forwarder UDP ports in message.
References forwarderCompIdsPtr(), and rtiexecForwarderCount().
Referenced by getRtiexecsAndForwarders(), setRtiexecsAndForwarders(), and tcpPortsPtr().
|
protectedvirtual |
References forwarderCompIdsPtr(), and rtiexecForwarderCount().
|
protected |
|
staticprotected |
Flag indicating that an entry is a forwarder.
Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
staticprotected |
Flag indicating that, if entry is for a forwarder, the forwarder is also aware of an rtiexec in its network.
Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().
|
staticprotected |
Flag indicating that an entry is an rtiexec.
Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().