MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtAssistantInfoMsg Class Reference

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. More...
 
 DtAssistantInfoMsg (const DtNetAssistantInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual ~DtAssistantInfoMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setRtiexecsAndForwarders (const DtRtiConnectionAndConfiguration &rtiexecsAndForwarders)
 Set rtiexec and forwarder information. More...
 
virtual void getRtiexecsAndForwarders (DtRtiConnectionAndConfiguration &rtiexecsAndForwarders, const MAKRti::DtInetAddr &interfaceReceivedOn, bool ignoreInterface=false) const
 Get rtiexec and forwarder information Public addresses for connections are not resolved. More...
 
virtual void setInterfaces (const DtInetAddrSet &localInterAddrs)
 Set the interfaces for the assistant host. More...
 
virtual void getInterfaces (DtInetAddrSet &localInterAddrs) const
 Get the interfaces for the assistant host. More...
 
virtual bool isRemoval () const
 Get/Set whether the message is indicating the removal of the specified rtiexecs and license servers. More...
 
virtual void setRemoval (bool val)
 
virtual bool remoteCmdsAccepted () const
 Get/Set whether the sending assistant is accepting remote commands (e.g. More...
 
virtual void setRemoteCmdsAccepted (bool val)
 
virtual unsigned int assistantInfoMemoryPeriod () const
 Get / Set the assistant information memory period. More...
 
virtual void setAssistantInfoMemoryPeriod (unsigned int interval)
 
virtual void setAssistantUuid (const DtAssistantUuid &assistantUuid)
 Set/Get owning rtiAssistant's UUID. More...
 
virtual const DtAssistantUuidassistantUuid () const
 
virtual void printData () const
 Print the data section. More...
 
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor. More...
 
virtual DtNetAssistantMsgHeadernetHeader () const
 Get header of network representation. More...
 
virtual int version () const
 Return the message version. More...
 
virtual bool isValidVersion () const
 Returns bool: message version is valid? More...
 
virtual DtAssistantMsgKind msgKind () const
 Get the message kind. More...
 
virtual void print () const
 Printing functions. More...
 
virtual void printHeader () const
 
virtual void printSrcDest () const
 
virtual bool isOk () const
 Message is good? More...
 
bool isAssistantToAssistantMessage () const
 Returns whether or not this message contains source/destination information included in messages sent between assistants. More...
 
virtual MAKRti::DtInetAddr sourceAddr () const
 Get/Set the IP address of the source of this message. More...
 
virtual void setSourceAddr (const MAKRti::DtInetAddr &addr)
 
virtual int sourceId () const
 Get/Set the ID of the source of this message. More...
 
virtual void setSourceId (int id)
 
virtual MAKRti::DtString sourceHost () const
 Get/Set the host name of the source of this message. More...
 
virtual void setSourceHost (const MAKRti::DtString &addr)
 
virtual MAKRti::DtInetAddr destAddr () const
 Get/Set the IP address of the destination of this message. More...
 
virtual void setDestAddr (const MAKRti::DtInetAddr &addr)
 
virtual int destId () const
 Get/Set the ID of the destination of this message. More...
 
virtual void setDestId (int id)
 
virtual int compId () const
 Get/Set the related component's connection ID. More...
 
virtual void setCompId (int compId)
 
virtual const DtAssistantUuidsourceUuid () const
 Get/Set the uuid of the source of this message. More...
 
virtual void setSourceUuid (const DtAssistantUuid &uuid)
 
virtual bool isForeign () const
 Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only. More...
 
virtual void setIsForeign (bool isForeignDestination)
 
virtual DtU32 sequence () const
 Get/Set sequence number Assistant-to-Assistant messages only. More...
 
virtual void setSequence (DtU32 sequenceNumber)
 

Static Public Member Functions

static void setSenderUuid (const DtAssistantUuid senderUuid)
 
static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators. More...
 
static DtAssistantMsgcreate (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. More...
 
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. More...
 

Protected Member Functions

virtual DtNetAssistantInfoMsgnetAssistantInfoMsg ()
 The network representation for the message. More...
 
virtual const
DtNetAssistantInfoMsg
netAssistantInfoMsg () const
 
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantInfoMsg message. More...
 
virtual int minSize () const
 Returns minimum size of a message, including header. More...
 
virtual void setLocalIpv4InterfaceCount (unsigned long count)
 Set/Get number of local Ipv4 interfaces. More...
 
virtual unsigned long localIpv4InterfaceCount () const
 
virtual void setLocalIpv6InterfaceCount (unsigned long count)
 Set/Get number of local Ipv6 interfaces. More...
 
virtual unsigned long localIpv6InterfaceCount () const
 
virtual void setRtiexecForwarderCount (unsigned long count)
 Set/Get number of rtiexecs/forwarders. More...
 
virtual unsigned long rtiexecForwarderCount () const
 
virtual const DtNetU128 * localInterfaceAddressPtr () const
 Return pointer to location of local interface addresses. More...
 
virtual DtNetU128 * localInterfaceAddressPtr ()
 
virtual const DtNetU128 * tcpAddressPtr () const
 Return pointer to location of rtiexec/forwarder TCP addresses. More...
 
virtual DtNetU128 * tcpAddressPtr ()
 
virtual const DtNetU128 * udpAddressPtr () const
 Return pointer to location of rtiexec/forwarder UDP addresses. More...
 
virtual DtNetU128 * udpAddressPtr ()
 
virtual const DtNetU128 * udpIntferfacePtr () const
 Return pointer to location of rtiexec/forwarder UDP interface addresses. More...
 
virtual DtNetU128 * udpIntferfacePtr ()
 
virtual const DtNetU32 * addressFamiliesPtr () const
 Return pointer to location of address families. More...
 
virtual DtNetU32 * addressFamiliesPtr ()
 
virtual const DtNetU32 * rtiexecCompIdsPtr () const
 Return pointer to location of rtiexec component IDs. More...
 
virtual DtNetU32 * rtiexecCompIdsPtr ()
 
virtual const DtNetU32 * forwarderCompIdsPtr () const
 Return pointer to location of forwarder component IDs. More...
 
virtual DtNetU32 * forwarderCompIdsPtr ()
 
virtual const DtNetU16 * tcpPortsPtr () const
 Return pointer to location of rtiexec/forwarder TCP ports. More...
 
virtual DtNetU16 * tcpPortsPtr ()
 
virtual const DtNetU16 * udpPortsPtr () const
 Return pointer to location of rtiexec/forwarder UDP ports. More...
 
virtual DtNetU16 * udpPortsPtr ()
 
virtual const DtNetU16 * forwarderPortsPtr () const
 Return pointer to location of forwarder-to-forwarder ports. More...
 
virtual DtNetU16 * forwarderPortsPtr ()
 
virtual const DtNetU8 * fullCompliancePtr () const
 Return pointer to location of rtiexec/forwarder full compliance settings. More...
 
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. More...
 
virtual DtNetU8 * rtiexecForwarderFlagPtr ()
 
virtual void setRtiexecForwarderNamesSize (unsigned long size)
 Set/Get rtiexec/forwarder connection names text size. More...
 
virtual unsigned long rtiexecForwarderNamesSize () const
 
virtual const char * rtiexecForwarderNamesPtr () const
 Return pointer to rtiexec/forwarder conn names location in msg. More...
 
virtual char * rtiexecForwarderNamesPtr ()
 
virtual void setHostNamesSize (unsigned long size)
 Set/Get rtiexec/forwarder host names text size. More...
 
virtual unsigned long hostNamesSize () const
 
virtual const char * hostNamesPtr () const
 Return pointer to rtiexec/forwarder host names location in msg. More...
 
virtual char * hostNamesPtr ()
 
virtual void setOwnerHostSize (unsigned size)
 Set/Get owning host names text size. More...
 
virtual unsigned ownerHostSize () const
 
virtual const char * ownerHostsPtr () const
 Return pointer to host names of the machines that own the conns. More...
 
virtual char * ownerHostsPtr ()
 
- Protected Member Functions inherited from DtAssistantMsg
 DtAssistantMsg ()
 Constructor. More...
 
virtual void sizeChanged (int size)
 Called whenever size is changed using changeSize, or insert/deleteBytes. More...
 
void initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
 Called by ctor, so not virtual. More...
 
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. More...
 
virtual void adjustBytes (void *address, int numBytes)
 Adjust the numBytes starting at the indicated address. More...
 
virtual void resizeForSrcDestInfo ()
 Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. More...
 
virtual const
DtNetAssistantSrcDestInfo
srcDestInfoPtr () const
 Return pointer to source/destination information in the message. More...
 
virtual DtNetAssistantSrcDestInfosrcDestInfoPtr ()
 
virtual void setSourceHostSize (unsigned long size)
 Set/Get source host name text size. More...
 
virtual unsigned long sourceHostSize () const
 
virtual const char * sourceHostPtr () const
 Return pointer to source host name in message. More...
 
virtual char * sourceHostPtr ()
 

Protected Attributes

std::map< DtRtiConnectionInfo,
DtRtiConnectionConfigurationInfo
myConfigurationsByConnectionMap
 

Static Protected Attributes

static const unsigned theRtiexecFlag
 Flag indicating that an entry is an rtiexec. More...
 
static const unsigned theForwarderFlag
 Flag indicating that an entry is a forwarder. More...
 
static const unsigned theForwarderHasRtiexecFlag
 Flag indicating that, if entry is for a forwarder, the forwarder is also aware of an rtiexec in its network. More...
 
static const unsigned theForwarderUsesRoutesFileFlag
 Flag indicating that, if entry is for a forwarder, the forwarder uses a routes file. More...
 
static DtAssistantUuid theSenderUuid
 The UUID of the sender assistant. Must be set by setSenderUuid() More...
 

Detailed Description

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.

Constructor & Destructor Documentation

DtAssistantInfoMsg::DtAssistantInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtAssistantInfoMsg::DtAssistantInfoMsg ( const DtNetAssistantInfoMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
virtual DtAssistantInfoMsg::~DtAssistantInfoMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantInfoMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantInfoCb  cb,
void *  usr 
)
static

Adds or removes a callback with the given Assistant peer for this message type.

virtual const DtNetU32* DtAssistantInfoMsg::addressFamiliesPtr ( ) const
protectedvirtual

Return pointer to location of address families.

virtual DtNetU32* DtAssistantInfoMsg::addressFamiliesPtr ( )
protectedvirtual
virtual unsigned int DtAssistantInfoMsg::assistantInfoMemoryPeriod ( ) const
virtual

Get / Set the assistant information memory period.

virtual const DtAssistantUuid& DtAssistantInfoMsg::assistantUuid ( ) const
virtual
virtual DtAssistantMsg* DtAssistantInfoMsg::clone ( bool  copy = true) const
virtual

Return a copy/empty object of the same type as this.

Implements DtAssistantMsg.

static DtAssistantMsg* DtAssistantInfoMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creators.

static DtAssistantMsg* DtAssistantInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
virtual const DtNetU32* DtAssistantInfoMsg::forwarderCompIdsPtr ( ) const
protectedvirtual

Return pointer to location of forwarder component IDs.

virtual DtNetU32* DtAssistantInfoMsg::forwarderCompIdsPtr ( )
protectedvirtual
virtual const DtNetU16* DtAssistantInfoMsg::forwarderPortsPtr ( ) const
protectedvirtual

Return pointer to location of forwarder-to-forwarder ports.

virtual DtNetU16* DtAssistantInfoMsg::forwarderPortsPtr ( )
protectedvirtual
virtual const DtNetU8* DtAssistantInfoMsg::fullCompliancePtr ( ) const
protectedvirtual

Return pointer to location of rtiexec/forwarder full compliance settings.

virtual DtNetU8* DtAssistantInfoMsg::fullCompliancePtr ( )
protectedvirtual
virtual void DtAssistantInfoMsg::getInterfaces ( DtInetAddrSet localInterAddrs) const
virtual

Get the interfaces for the assistant host.

virtual void DtAssistantInfoMsg::getRtiexecsAndForwarders ( DtRtiConnectionAndConfiguration