MAK RTIspy API Documentation for HLA 1516
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.
 DtAssistantInfoMsg (const DtNetAssistantInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantInfoMsg ()
 Destructor.
virtual DtAssistantMsgclone (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 DtNetAssistantMsgHeadernetHeader () 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 DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
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.
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 DtNetAssistantInfoMsgnetAssistantInfoMsg ()
 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 DtNetAssistantSrcDestInfosrcDestInfoPtr ()
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.

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.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

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

Destructor.

Member Function Documentation

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

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantInfoMsgKind.

Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().

const DtNetU32 * DtAssistantInfoMsg::addressFamiliesPtr ( ) const
protectedvirtual

Return pointer to location of address families in message.

References bestEffortAddrsPtr(), and rtiexecForwarderCount().

Referenced by getRtiexecsAndForwarders(), rtiexecCompIdsPtr(), and setRtiexecsAndForwarders().

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

Get / Set the assistant information memory period.

References DtNetAssistantInfoMsg::assistantInfoMemoryPeriod, and netAssistantInfoMsg().

Referenced by DtAssistantConnectionInfoMgr::processInfoMsg().

const DtNetU128 * DtAssistantInfoMsg::bestEffortAddrsPtr ( ) const
protectedvirtual

Return pointer to location of rtiexec/forwarder best effort addresses in message.

References reliableAddrsPtr(), and rtiexecForwarderCount().

Referenced by addressFamiliesPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

DtNetU128 * DtAssistantInfoMsg::bestEffortAddrsPtr ( )
protectedvirtual
DtAssistantMsg * DtAssistantInfoMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

References DtAssistantInfoMsg(), and netAssistantInfoMsg().

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

Creators.

References DtAssistantInfoMsg().

DtAssistantMsg * DtAssistantInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static

References DtAssistantInfoMsg().

const DtNetU32 * DtAssistantInfoMsg::forwarderCompIdsPtr ( ) const
protectedvirtual

Return pointer to location of forwarder component IDs in message.

References rtiexecCompIdsPtr(), and rtiexecForwarderCount().

Referenced by getRtiexecsAndForwarders(), setRtiexecsAndForwarders(), and udpPortsPtr().

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

Return pointer to location of forwarder-to-forwarder ports in the message.

References rtiexecForwarderCount(), and tcpPortsPtr().

Referenced by fullCompliancePtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

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

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

References forwarderPortsPtr(), and rtiexecForwarderCount().

Referenced by getRtiexecsAndForwarders(), rtiexecForwarderFlagPtr(), and setRtiexecsAndForwarders().

DtNetU8 * DtAssistantInfoMsg::fullCompliancePtr ( )
protectedvirtual
void DtAssistantInfoMsg::getRtiexecsAndForwarders ( DtRtiConnectionAndConfiguration rtiexecsAndForwarders,
const MAKRti::DtInetAddr &  interfaceReceivedOn 
) const
virtual
const char * DtAssistantInfoMsg::hostNamesPtr ( ) const
protectedvirtual

Return pointer to rtiexec/forwarder host names location in msg.

References rtiexecForwarderNamesPtr(), and rtiexecForwarderNamesSize().

Referenced by getRtiexecsAndForwarders(), ownerHostsPtr(), and setRtiexecsAndForwarders().

char * DtAssistantInfoMsg::hostNamesPtr ( )
protectedvirtual
unsigned long DtAssistantInfoMsg::hostNamesSize ( ) const
protectedvirtual
DtAssistantMsgKind DtAssistantInfoMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantInfoMsgKind.

Referenced by DtAssistantInfoMsg().

bool DtAssistantInfoMsg::isRemoval ( ) const
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().

int DtAssistantInfoMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantInfoMsg().

DtNetAssistantInfoMsg * DtAssistantInfoMsg::netAssistantInfoMsg ( )
protectedvirtual
const DtNetAssistantInfoMsg * DtAssistantInfoMsg::netAssistantInfoMsg ( ) const
protectedvirtual
unsigned DtAssistantInfoMsg::ownerHostSize ( ) const
protectedvirtual
const char * DtAssistantInfoMsg::ownerHostsPtr ( ) const
protectedvirtual

Return pointer to host names of the machines that own the conns.

References hostNamesPtr(), and hostNamesSize().

Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

char * DtAssistantInfoMsg::ownerHostsPtr ( )
protectedvirtual

References hostNamesPtr(), and hostNamesSize().

void DtAssistantInfoMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

const DtNetU128 * DtAssistantInfoMsg::reliableAddrsPtr ( ) const
protectedvirtual

Return pointer to location of rtiexec/forwarder reliable addresses in message.

References netAssistantInfoMsg().

Referenced by bestEffortAddrsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

DtNetU128 * DtAssistantInfoMsg::reliableAddrsPtr ( )
protectedvirtual

References netAssistantInfoMsg().

bool DtAssistantInfoMsg::remoteCmdsAccepted ( ) const
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().

void DtAssistantInfoMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantInfoCb  cb,
void *  usr 
)
static
const DtNetU32 * DtAssistantInfoMsg::rtiexecCompIdsPtr ( ) const
protectedvirtual

Return pointer to location of rtiexec component IDs in message.

References addressFamiliesPtr(), and rtiexecForwarderCount().

Referenced by forwarderCompIdsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

DtNetU32 * DtAssistantInfoMsg::rtiexecCompIdsPtr ( )
protectedvirtual
unsigned long DtAssistantInfoMsg::rtiexecForwarderCount ( ) const
protectedvirtual
const DtNetU8 * DtAssistantInfoMsg::rtiexecForwarderFlagPtr ( ) const
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().

DtNetU8 * DtAssistantInfoMsg::rtiexecForwarderFlagPtr ( )
protectedvirtual
const char * DtAssistantInfoMsg::rtiexecForwarderNamesPtr ( ) const
protectedvirtual

Return pointer to rtiexec/forwarder conn names location in msg.

References rtiexecForwarderCount(), and rtiexecForwarderFlagPtr().

Referenced by getRtiexecsAndForwarders(), hostNamesPtr(), and setRtiexecsAndForwarders().

char * DtAssistantInfoMsg::rtiexecForwarderNamesPtr ( )
protectedvirtual
unsigned long DtAssistantInfoMsg::rtiexecForwarderNamesSize ( ) const
protectedvirtual
void DtAssistantInfoMsg::setAssistantInfoMemoryPeriod ( unsigned int  interval)
virtual
void DtAssistantInfoMsg::setHostNamesSize ( unsigned long  size)
protectedvirtual

Set/Get rtiexec/forwarder host names text size.

References DtNetAssistantInfoMsg::hostNamesSize, and netAssistantInfoMsg().

Referenced by setRtiexecsAndForwarders().

void DtAssistantInfoMsg::setOwnerHostSize ( unsigned  size)
protectedvirtual

Set/Get owning host names text size.

References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::ownerHostSize.

Referenced by setRtiexecsAndForwarders().

void DtAssistantInfoMsg::setRemoteCmdsAccepted ( bool  val)
virtual
void DtAssistantInfoMsg::setRemoval ( bool  val)
virtual
void DtAssistantInfoMsg::setRtiexecForwarderCount ( unsigned long  count)
protectedvirtual

Set/Get number of rtiexecs/forwarders included in message.

References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderCount.

Referenced by setRtiexecsAndForwarders().

void DtAssistantInfoMsg::setRtiexecForwarderNamesSize ( unsigned long  size)
protectedvirtual

Set/Get rtiexec/forwarder connection names text size.

References netAssistantInfoMsg(), and DtNetAssistantInfoMsg::rtiexecForwarderNamesSize.

Referenced by setRtiexecsAndForwarders().

void DtAssistantInfoMsg::setRtiexecsAndForwarders ( const DtRtiConnectionAndConfiguration rtiexecsAndForwarders)
virtual
const DtNetU16 * DtAssistantInfoMsg::tcpPortsPtr ( ) const
protectedvirtual

Return pointer to location of rtiexec/forwarder TCP ports in message.

References rtiexecForwarderCount(), and udpPortsPtr().

Referenced by forwarderPortsPtr(), getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

DtNetU16 * DtAssistantInfoMsg::tcpPortsPtr ( )
protectedvirtual
const DtNetU16 * DtAssistantInfoMsg::udpPortsPtr ( ) const
protectedvirtual

Return pointer to location of rtiexec/forwarder UDP ports in message.

References forwarderCompIdsPtr(), and rtiexecForwarderCount().

Referenced by getRtiexecsAndForwarders(), setRtiexecsAndForwarders(), and tcpPortsPtr().

DtNetU16 * DtAssistantInfoMsg::udpPortsPtr ( )
protectedvirtual

Member Data Documentation

std::map<DtRtiConnectionInfo, DtRtiConnectionConfigurationInfo> DtAssistantInfoMsg::myConfigurationsByConnectionMap
protected
const unsigned DtAssistantInfoMsg::theForwarderFlag = 0x2
staticprotected

Flag indicating that an entry is a forwarder.

Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().

const unsigned DtAssistantInfoMsg::theForwarderHasRtiexecFlag = 0x4
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().

const unsigned DtAssistantInfoMsg::theRtiexecFlag = 0x1
staticprotected

Flag indicating that an entry is an rtiexec.

Referenced by getRtiexecsAndForwarders(), and setRtiexecsAndForwarders().


The documentation for this class was generated from the following files:

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)