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
DtAssistantLightweightInfoMsg Class Reference

The DtAssistantLightweightInfoMsg defines a wrapper for the RTI Assistant lightweight connection information message used by the Assistants to share known lightweight connection information with one another. More...

+ Inheritance diagram for DtAssistantLightweightInfoMsg:
+ Collaboration diagram for DtAssistantLightweightInfoMsg:

Public Member Functions

 DtAssistantLightweightInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors. More...
 
 DtAssistantLightweightInfoMsg (const DtNetAssistantLightweightInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual ~DtAssistantLightweightInfoMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setLightweightConns (const DtRtiConnectionAndConfiguration &lightweightConnections)
 Set/Get lightweight connection information. More...
 
virtual void getLightweightConns (DtRtiConnectionAndConfiguration &lightweightConnections, const MAKRti::DtInetAddr &networkInterfaceReceivedOn) const
 
virtual unsigned int lightweightMemoryPeriod () const
 Get / Set the lightweight connection memory period. More...
 
virtual void setLightweightMemoryPeriod (unsigned int interval)
 
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 DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators. More...
 
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantLightweightInfoCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type. More...
 
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantLightweightInfoCb 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
DtNetAssistantLightweightInfoMsg
netAssistantLightweightInfoMsg ()
 The network representation for the message. More...
 
virtual const
DtNetAssistantLightweightInfoMsg
netAssistantLightweightInfoMsg () const
 
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantLightweightInfoMsg message. More...
 
virtual int minSize () const
 Returns minimum size of a message, including header. More...
 
virtual void setLightweightConnCount (unsigned count)
 Set/Get number of lightweight connections included in message. More...
 
virtual unsigned lightweightConnCount () const
 
virtual void setLightweightNamesSize (unsigned size)
 Set/Get lightweight connection names text size. More...
 
virtual unsigned lightweightNamesSize () const
 
virtual void setOwnerHostSize (unsigned size)
 Set/Get owning host names text size. More...
 
virtual unsigned ownerHostSize () const
 
virtual const DtNetU128 * lightweightUdpAddrsPtr () const
 Return pointer to UDP addresses (best effort) location in message. More...
 
virtual DtNetU128 * lightweightUdpAddrsPtr ()
 
virtual const DtNetU32 * addressFamiliesPtr () const
 Return pointer to location of address families in message. More...
 
virtual DtNetU32 * addressFamiliesPtr ()
 
virtual const DtNetU16 * lightweightPortsPtr () const
 Return pointer to lightweight connections port location in message. More...
 
virtual DtNetU16 * lightweightPortsPtr ()
 
virtual const char * lightweightNamesPtr () const
 Return pointer to lightweight conn names location in msg. More...
 
virtual char * lightweightNamesPtr ()
 
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 ()
 

Detailed Description

The DtAssistantLightweightInfoMsg defines a wrapper for the RTI Assistant lightweight connection information message used by the Assistants to share known lightweight connection information with one another.

Constructor & Destructor Documentation

DtAssistantLightweightInfoMsg::DtAssistantLightweightInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtAssistantLightweightInfoMsg::DtAssistantLightweightInfoMsg ( const DtNetAssistantLightweightInfoMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
virtual DtAssistantLightweightInfoMsg::~DtAssistantLightweightInfoMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantLightweightInfoMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantLightweightInfoCb  cb,
void *  usr 
)
static

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

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

Return pointer to location of address families in message.

virtual DtNetU32* DtAssistantLightweightInfoMsg::addressFamiliesPtr ( )
protectedvirtual
virtual DtAssistantMsg* DtAssistantLightweightInfoMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

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

Creators.

static DtAssistantMsg* DtAssistantLightweightInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
virtual void DtAssistantLightweightInfoMsg::getLightweightConns ( DtRtiConnectionAndConfiguration lightweightConnections,
const MAKRti::DtInetAddr &  networkInterfaceReceivedOn 
) const
virtual
virtual DtAssistantMsgKind DtAssistantLightweightInfoMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantLightweightInfoMsg message.

Implements DtAssistantMsg.

virtual unsigned DtAssistantLightweightInfoMsg::lightweightConnCount ( ) const
protectedvirtual
virtual unsigned int DtAssistantLightweightInfoMsg::lightweightMemoryPeriod ( ) const
virtual

Get / Set the lightweight connection memory period.

virtual const char* DtAssistantLightweightInfoMsg::lightweightNamesPtr ( ) const
protectedvirtual

Return pointer to lightweight conn names location in msg.

virtual char* DtAssistantLightweightInfoMsg::lightweightNamesPtr ( )
protectedvirtual
virtual unsigned DtAssistantLightweightInfoMsg::lightweightNamesSize ( ) const
protectedvirtual
virtual const DtNetU16* DtAssistantLightweightInfoMsg::lightweightPortsPtr ( ) const
protectedvirtual

Return pointer to lightweight connections port location in message.

virtual DtNetU16* DtAssistantLightweightInfoMsg::lightweightPortsPtr ( )
protectedvirtual
virtual const DtNetU128* DtAssistantLightweightInfoMsg::lightweightUdpAddrsPtr ( ) const
protectedvirtual

Return pointer to UDP addresses (best effort) location in message.

virtual DtNetU128* DtAssistantLightweightInfoMsg::lightweightUdpAddrsPtr ( )
protectedvirtual
virtual int DtAssistantLightweightInfoMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantLightweightInfoMsg* DtAssistantLightweightInfoMsg::netAssistantLightweightInfoMsg ( )
protectedvirtual

The network representation for the message.

virtual const DtNetAssistantLightweightInfoMsg* DtAssistantLightweightInfoMsg::netAssistantLightweightInfoMsg ( ) const
protectedvirtual
virtual unsigned DtAssistantLightweightInfoMsg::ownerHostSize ( ) const
protectedvirtual
virtual const char* DtAssistantLightweightInfoMsg::ownerHostsPtr ( ) const
protectedvirtual

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

virtual char* DtAssistantLightweightInfoMsg::ownerHostsPtr ( )
protectedvirtual
virtual void DtAssistantLightweightInfoMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantLightweightInfoMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantLightweightInfoCb  cb,
void *  usr 
)
static
virtual void DtAssistantLightweightInfoMsg::setLightweightConnCount ( unsigned  count)
protectedvirtual

Set/Get number of lightweight connections included in message.

virtual void DtAssistantLightweightInfoMsg::setLightweightConns ( const DtRtiConnectionAndConfiguration lightweightConnections)
virtual

Set/Get lightweight connection information.

virtual void DtAssistantLightweightInfoMsg::setLightweightMemoryPeriod ( unsigned int  interval)
virtual
virtual void DtAssistantLightweightInfoMsg::setLightweightNamesSize ( unsigned  size)
protectedvirtual

Set/Get lightweight connection names text size.

virtual void DtAssistantLightweightInfoMsg::setOwnerHostSize ( unsigned  size)
protectedvirtual

Set/Get owning host names text size.


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

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)