MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtForwarderNodeInfoMsg Class Reference

The DtForwarderNodeInfoMsg defines a msg for a client to report the results of a latency test. More...

+ Inheritance diagram for DtForwarderNodeInfoMsg:
+ Collaboration diagram for DtForwarderNodeInfoMsg:

Public Member Functions

 DtForwarderNodeInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtForwarderNodeInfoMsg (const DtNetForwarderNodeInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtForwarderNodeInfoMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print the data section.
virtual void setInetAddr (const MAKRti::DtInetAddr &addr)
virtual MAKRti::DtInetAddr getInetAddr () const
virtual void setNodeId (unsigned long nodeId)
virtual unsigned long getNodeId () const
virtual void setPort (int nodeId)
virtual int getPort () const
virtual void setForwarderName (const MAKRti::DtString &name)
virtual MAKRti::DtString forwarderName () const
virtual void setForwarderHostName (const MAKRti::DtString &name)
virtual MAKRti::DtString forwarderHostName () const
virtual void setKnownForwarderNodes (const std::set< DtForwarderNodeInfo > &nodes)
virtual void knownForwarderNodes (std::set< DtForwarderNodeInfo > &nodesToPopulate) const
virtual void setNodeIdForRecipientToUse (unsigned long nodeId)
virtual unsigned long nodeIdForRecipientToUse () const
- Public Member Functions inherited from DtRtiMsg
virtual ~DtRtiMsg ()
 Destructor.
virtual DtRtiMsgcloneWithTransport (bool copy=true) const
 Return a copy/empty object of the same type as this using clone and set the transport type from the host message.
virtual DtNetMsgHeadernetHeader () 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 void setFedEx (const MAKRti::DtString &name)
 All RTI messages contain information to identify which federation execution the message applies to.
virtual void setFedEx (int handle)
 Set federation execution identifier as a handle.
virtual bool isForExec (const MAKRti::DtString &execName, int execHandle) const
 Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind msgKind () const
 Get the message kind.
virtual const char * kindString () const
 Returns the message kind string name.
virtual bool isConstrained () const
 Return boolean: message type can be time constrained?
virtual bool isAllowedDuringSave () const
 Return boolean: message type can be processed during save?
virtual void setTime (const RTI::FedTime &time)
 Set/Get time Used in timestamped messages.
virtual RTI::FedTime const * time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool hasTime () const
 Returns true if time field is valid.
virtual void setSerialNumber (unsigned long serialNumberValue)
 Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long serialNumber () const
virtual void setTransportType (DtTransportHandle type)
 Set/Get transport type.
virtual DtTransportHandle transportType () const
virtual DtOrderHandle orderType () const
 This base implementation always returns recieve order.
virtual bool isMetadataPresent () const
 Test if metadata has been added to a DtRtiMsg object.
virtual bool addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
 Allocate space for next block of metadata.
virtual void removeMetadata (unsigned int size)
 Update the size of the message when metadata has been removed.
bool isInteractionMsgType () const
 Utility functions, check the message type against known interaciton/update message types.
bool isUpdateMsgType () const
virtual void print (DtLogicalTimeFactory *logicalTimeFactory) const
 Printing functions.
virtual void printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void printTime (const char *label, RTI::FedTime const *timeValue) const
 Print the given time.
virtual void printInterval (const char *label, RTI::FedTime const *intervalValue) const
 Print the interval.
virtual int status () const
 Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString fedExName () const
 These two functions should be avoided in favor of isForExec().
virtual int fedExHandle () const
 Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void setFederateHandle (DtFederateHandle handle)
 Set/Get federate handle.
virtual DtFederateHandle federateHandle () const
 Set/Get federate handle.
virtual void setSequenceNumber (unsigned long value)
 Set/Get message sequence number.
virtual unsigned long sequenceNumber () const
 Set/Get message sequence number.
virtual void setServiceCallNumber (unsigned long value)
 Set/Get service call number.
virtual unsigned long serviceCallNumber () const
 Set/Get service call number.
virtual void setTriggerMessageNumber (unsigned long value)
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long triggerMessageNumber () const
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

Static Public Member Functions

static DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtConnectionMgr *conn, DtForwarderNodeInfoCb cb, void *usr)
 Adds or removes a callback with the given connection manager for this message type.
static void removeCallback (DtConnectionMgr *conn, DtForwarderNodeInfoCb cb, void *usr)
- Static Public Member Functions inherited from DtRtiMsg
static const char * kindToString (DtRtiMsgKind kind)
 Returns the name of the message, by kind enumeration.
static const char * kindString (const void *buffer)
 Extracts the message kind from the given buffer and returns its string name.
static void setDefaultRegionSet (unsigned long defaultRegionSet)
 Set the default region set handle.
static void setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
 Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool use32BitsForValueSize ()
static void setSmartForwardingEnabled (bool enabled)
 Set/Get is SmartForwarding enabled?
static bool smartForwardingEnabled ()

Protected Member Functions

virtual DtNetForwarderNodeInfoMsgnetForwarderNodeInfoMsg ()
 The network representation for the ForwarderNodeInfoMsg message.
virtual const
DtNetForwarderNodeInfoMsg
netForwarderNodeInfoMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of a DtForwarderNodeInfoMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual const char * forwarderNamePtr () const
 utility functions for getting / setting forwarderName.
virtual char * forwarderNamePtr ()
virtual void setForwarderNameSize (unsigned int size)
virtual unsigned int forwarderNameSize () const
virtual const char * forwarderHostNamePtr () const
 utility functions for getting / setting forwarderHostName
virtual char * forwarderHostNamePtr ()
virtual void setForwarderHostNameSize (unsigned int size)
virtual unsigned int forwarderHostNameSize () const
virtual void setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily num)
 utility functions for getting / setting address family of all IP addresses in the message
virtual
MAKRti::DtInetUtils::DtInetAddrFamily 
addressFamily () const
virtual void setNumKnownForwarder (unsigned long num)
 utility functions for getting / setting number of known forwarders
virtual unsigned long numKnownForwarders () const
virtual const DtNetU128 * knownFwAddrsPtr () const
 utility functions for getting / setting known forwarder addresses
virtual DtNetU128 * knownFwAddrsPtr ()
virtual const DtNetU32 * knownFwNodeIdsPtr () const
 utility functions for getting / setting known forwarder node ids
virtual DtNetU32 * knownFwNodeIdsPtr ()
virtual const char * knownFwNamesPtr () const
 utility functions for getting / setting known forwarder names
virtual char * knownFwNamesPtr ()
virtual void setKnownFwNamesSize (unsigned long size)
virtual unsigned long knownFwNamesSize () const
virtual const char * knownFwHostNamesPtr () const
 utility functions for getting / setting known forwarder host names
virtual char * knownFwHostNamesPtr ()
virtual void setKnownFwHostNamesSize (unsigned long size)
virtual unsigned long knownFwHostNamesSize () const
- Protected Member Functions inherited from DtRtiMsg
 DtRtiMsg ()
 Constructor.
virtual void sizeChanged (int size)
 Called whenever size is changed using changeSize, or insert/deleteBytes.
void initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
 Called by ctor, so not virtual.
void initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void initDtRtiMsg (const DtNetMsgHeader *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 addres.

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle = 0
static const char * theDefaultTag = NULL
- Protected Attributes inherited from DtRtiMsg
DtTransportHandle myTransportType
DtOrderHandle myOrderType
RTI::FedTimemyFedTime
bool myTimeIsValid
bool myConstrained
bool myAllowedDuringSave
unsigned long mySerialNumber
unsigned long myServiceCallNumber
unsigned long myTriggerMessage
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize = false
static bool theSmartForwardingEnabled = false

Detailed Description

The DtForwarderNodeInfoMsg defines a msg for a client to report the results of a latency test.

Constructor & Destructor Documentation

DtForwarderNodeInfoMsg::DtForwarderNodeInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtForwarderNodeInfoMsg::DtForwarderNodeInfoMsg ( const DtNetForwarderNodeInfoMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtForwarderNodeInfoMsg::~DtForwarderNodeInfoMsg ( )
virtual

Destructor.

Member Function Documentation

void DtForwarderNodeInfoMsg::addCallback ( DtConnectionMgr conn,
DtForwarderNodeInfoCb  cb,
void *  usr 
)
static

Adds or removes a callback with the given connection manager for this message type.

References DtConnectionMgr::addMsgCallback(), and DtForwarderNodeInfoMsgKind.

MAKRti::DtInetUtils::DtInetAddrFamily DtForwarderNodeInfoMsg::addressFamily ( ) const
protectedvirtual
DtRtiMsg * DtForwarderNodeInfoMsg::clone ( bool  copy = true) const
virtual

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

Implements DtRtiMsg.

References DtForwarderNodeInfoMsg(), and netForwarderNodeInfoMsg().

DtRtiMsg * DtForwarderNodeInfoMsg::create ( const DtNetMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creators.

References DtForwarderNodeInfoMsg().

DtRtiMsg * DtForwarderNodeInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
MAKRti::DtString DtForwarderNodeInfoMsg::forwarderHostName ( ) const
virtual
const char * DtForwarderNodeInfoMsg::forwarderHostNamePtr ( ) const
protectedvirtual

utility functions for getting / setting forwarderHostName

References forwarderNamePtr(), and forwarderNameSize().

Referenced by forwarderHostName(), and setForwarderHostName().

char * DtForwarderNodeInfoMsg::forwarderHostNamePtr ( )
protectedvirtual
unsigned int DtForwarderNodeInfoMsg::forwarderHostNameSize ( ) const
protectedvirtual
MAKRti::DtString DtForwarderNodeInfoMsg::forwarderName ( ) const
virtual
const char * DtForwarderNodeInfoMsg::forwarderNamePtr ( ) const
protectedvirtual

utility functions for getting / setting forwarderName.

References knownFwHostNamesPtr(), and knownFwHostNamesSize().

Referenced by forwarderHostNamePtr(), forwarderName(), and setForwarderName().

char * DtForwarderNodeInfoMsg::forwarderNamePtr ( )
protectedvirtual
unsigned int DtForwarderNodeInfoMsg::forwarderNameSize ( ) const
protectedvirtual
MAKRti::DtInetAddr DtForwarderNodeInfoMsg::getInetAddr ( ) const
virtual
unsigned long DtForwarderNodeInfoMsg::getNodeId ( ) const
virtual
int DtForwarderNodeInfoMsg::getPort ( ) const
virtual
DtRtiMsgKind DtForwarderNodeInfoMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of a DtForwarderNodeInfoMsg message.

Implements DtRtiMsg.

References DtForwarderNodeInfoMsgKind.

Referenced by DtForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::knownForwarderNodes ( std::set< DtForwarderNodeInfo > &  nodesToPopulate) const
virtual
const DtNetU128 * DtForwarderNodeInfoMsg::knownFwAddrsPtr ( ) const
protectedvirtual

utility functions for getting / setting known forwarder addresses

References netForwarderNodeInfoMsg().

Referenced by knownFwNodeIdsPtr(), and setKnownForwarderNodes().

DtNetU128 * DtForwarderNodeInfoMsg::knownFwAddrsPtr ( )
protectedvirtual
const char * DtForwarderNodeInfoMsg::knownFwHostNamesPtr ( ) const
protectedvirtual

utility functions for getting / setting known forwarder host names

References knownFwNamesPtr(), and knownFwNamesSize().

Referenced by forwarderNamePtr(), and setKnownForwarderNodes().

char * DtForwarderNodeInfoMsg::knownFwHostNamesPtr ( )
protectedvirtual
unsigned long DtForwarderNodeInfoMsg::knownFwHostNamesSize ( ) const
protectedvirtual
const char * DtForwarderNodeInfoMsg::knownFwNamesPtr ( ) const
protectedvirtual

utility functions for getting / setting known forwarder names

References knownFwNodeIdsPtr(), and numKnownForwarders().

Referenced by knownFwHostNamesPtr(), and setKnownForwarderNodes().

char * DtForwarderNodeInfoMsg::knownFwNamesPtr ( )
protectedvirtual
unsigned long DtForwarderNodeInfoMsg::knownFwNamesSize ( ) const
protectedvirtual
const DtNetU32 * DtForwarderNodeInfoMsg::knownFwNodeIdsPtr ( ) const
protectedvirtual

utility functions for getting / setting known forwarder node ids

References knownFwAddrsPtr(), and numKnownForwarders().

Referenced by knownFwNamesPtr(), and setKnownForwarderNodes().

DtNetU32 * DtForwarderNodeInfoMsg::knownFwNodeIdsPtr ( )
protectedvirtual
int DtForwarderNodeInfoMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

DtNetForwarderNodeInfoMsg * DtForwarderNodeInfoMsg::netForwarderNodeInfoMsg ( )
protectedvirtual
const DtNetForwarderNodeInfoMsg * DtForwarderNodeInfoMsg::netForwarderNodeInfoMsg ( ) const
protectedvirtual
unsigned long DtForwarderNodeInfoMsg::nodeIdForRecipientToUse ( ) const
virtual
unsigned long DtForwarderNodeInfoMsg::numKnownForwarders ( ) const
protectedvirtual
void DtForwarderNodeInfoMsg::printData ( ) const
virtual
void DtForwarderNodeInfoMsg::removeCallback ( DtConnectionMgr conn,
DtForwarderNodeInfoCb  cb,
void *  usr 
)
static
void DtForwarderNodeInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  num)
protectedvirtual

utility functions for getting / setting address family of all IP addresses in the message

References DtNetForwarderNodeInfoMsg::addrFamily, and netForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setForwarderHostName ( const MAKRti::DtString &  name)
virtual
void DtForwarderNodeInfoMsg::setForwarderHostNameSize ( unsigned int  size)
protectedvirtual
void DtForwarderNodeInfoMsg::setForwarderName ( const MAKRti::DtString &  name)
virtual
void DtForwarderNodeInfoMsg::setForwarderNameSize ( unsigned int  size)
protectedvirtual
void DtForwarderNodeInfoMsg::setInetAddr ( const MAKRti::DtInetAddr &  addr)
virtual
void DtForwarderNodeInfoMsg::setKnownForwarderNodes ( const std::set< DtForwarderNodeInfo > &  nodes)
virtual
void DtForwarderNodeInfoMsg::setKnownFwHostNamesSize ( unsigned long  size)
protectedvirtual
void DtForwarderNodeInfoMsg::setKnownFwNamesSize ( unsigned long  size)
protectedvirtual
void DtForwarderNodeInfoMsg::setNodeId ( unsigned long  nodeId)
virtual
void DtForwarderNodeInfoMsg::setNodeIdForRecipientToUse ( unsigned long  nodeId)
virtual
void DtForwarderNodeInfoMsg::setNumKnownForwarder ( unsigned long  num)
protectedvirtual

utility functions for getting / setting number of known forwarders

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::numKnownForwarders.

Referenced by setKnownForwarderNodes().

void DtForwarderNodeInfoMsg::setPort ( int  nodeId)
virtual

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)