MAK RTIspy API Documentation for HLA 1.3
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:

List of all members.

Public Member Functions

 DtAssistantLightweightInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantLightweightInfoMsg (const DtNetAssistantLightweightInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantLightweightInfoMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setLightweightConns (const DtRtiConnectionAndConfiguration &lightweightConnections)
 Set/Get lightweight connection information.
virtual void getLightweightConns (DtRtiConnectionAndConfiguration &lightweightConnections, const MAKRti::DtInetAddr &networkInterfaceReceivedOn) const
virtual unsigned int lightweightMemoryPeriod () const
 Get / Set the lightweight connection memory period.
virtual void setLightweightMemoryPeriod (unsigned int interval)
virtual void printData () const
 Print the data section.

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, DtAssistantLightweightInfoCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantLightweightInfoCb cb, void *usr)

Protected Member Functions

virtual
DtNetAssistantLightweightInfoMsg
netAssistantLightweightInfoMsg ()
 The network representation for the message.
virtual const
DtNetAssistantLightweightInfoMsg
netAssistantLightweightInfoMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantLightweightInfoMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setLightweightConnCount (unsigned count)
 Set/Get number of lightweight connections included in message.
virtual unsigned lightweightConnCount () const
virtual void setLightweightNamesSize (unsigned size)
 Set/Get lightweight connection names text size.
virtual unsigned lightweightNamesSize () const
virtual void setOwnerHostSize (unsigned size)
 Set/Get owning host names text size.
virtual unsigned ownerHostSize () const
virtual const DtNetU128 * lightweightBestEffortAddrsPtr () const
 Return pointer to best effort addresses location in message.
virtual DtNetU128 * lightweightBestEffortAddrsPtr ()
virtual const DtNetU32 * addressFamiliesPtr () const
 Return pointer to location of address families in message.
virtual DtNetU32 * addressFamiliesPtr ()
virtual const DtNetU16 * lightweightPortsPtr () const
 Return pointer to lightweight connections port location in message.
virtual DtNetU16 * lightweightPortsPtr ()
virtual const char * lightweightNamesPtr () const
 Return pointer to lightweight conn names location in msg.
virtual char * lightweightNamesPtr ()
virtual const char * ownerHostsPtr () const
 Return pointer to host names of the machines that own the conns.
virtual char * ownerHostsPtr ()

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.

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

Referenced by clone(), and create().

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

Destructor.


Member Function Documentation

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLightweightInfoMsgKind.

Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().

const DtNetU32 * DtAssistantLightweightInfoMsg::addressFamiliesPtr ( ) const [protected, virtual]

Return pointer to location of address families in message.

References lightweightBestEffortAddrsPtr(), and lightweightConnCount().

Referenced by getLightweightConns(), lightweightPortsPtr(), and setLightweightConns().

DtNetU32 * DtAssistantLightweightInfoMsg::addressFamiliesPtr ( ) [protected, virtual]

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

Implements DtAssistantMsg.

References DtAssistantLightweightInfoMsg(), and netAssistantLightweightInfoMsg().

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

Creators.

References DtAssistantLightweightInfoMsg().

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

Returns the kind of a DtAssistantLightweightInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantLightweightInfoMsgKind.

Referenced by DtAssistantLightweightInfoMsg().

const DtNetU128 * DtAssistantLightweightInfoMsg::lightweightBestEffortAddrsPtr ( ) const [protected, virtual]

Return pointer to best effort addresses location in message.

References netAssistantLightweightInfoMsg().

Referenced by addressFamiliesPtr(), getLightweightConns(), and setLightweightConns().

unsigned DtAssistantLightweightInfoMsg::lightweightConnCount ( ) const [protected, virtual]
const char * DtAssistantLightweightInfoMsg::lightweightNamesPtr ( ) const [protected, virtual]

Return pointer to lightweight conn names location in msg.

References lightweightConnCount(), and lightweightPortsPtr().

Referenced by getLightweightConns(), ownerHostsPtr(), and setLightweightConns().

char * DtAssistantLightweightInfoMsg::lightweightNamesPtr ( ) [protected, virtual]
unsigned DtAssistantLightweightInfoMsg::lightweightNamesSize ( ) const [protected, virtual]
const DtNetU16 * DtAssistantLightweightInfoMsg::lightweightPortsPtr ( ) const [protected, virtual]

Return pointer to lightweight connections port location in message.

References addressFamiliesPtr(), and lightweightConnCount().

Referenced by getLightweightConns(), lightweightNamesPtr(), and setLightweightConns().

DtNetU16 * DtAssistantLightweightInfoMsg::lightweightPortsPtr ( ) [protected, virtual]
int DtAssistantLightweightInfoMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantLightweightInfoMsg().

unsigned DtAssistantLightweightInfoMsg::ownerHostSize ( ) const [protected, virtual]
const char * DtAssistantLightweightInfoMsg::ownerHostsPtr ( ) const [protected, virtual]

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

References lightweightNamesPtr(), and lightweightNamesSize().

Referenced by getLightweightConns(), and setLightweightConns().

char * DtAssistantLightweightInfoMsg::ownerHostsPtr ( ) [protected, virtual]
void DtAssistantLightweightInfoMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantLightweightInfoMsg::setLightweightConnCount ( unsigned  count) [protected, virtual]

Set/Get number of lightweight connections included in message.

References DtNetAssistantLightweightInfoMsg::lightweightConnectionsCount, and netAssistantLightweightInfoMsg().

Referenced by setLightweightConns().

void DtAssistantLightweightInfoMsg::setLightweightConns ( const DtRtiConnectionAndConfiguration lightweightConnections) [virtual]
void DtAssistantLightweightInfoMsg::setLightweightMemoryPeriod ( unsigned int  interval) [virtual]
void DtAssistantLightweightInfoMsg::setLightweightNamesSize ( unsigned  size) [protected, virtual]

Set/Get lightweight connection names text size.

References DtNetAssistantLightweightInfoMsg::lwConnNamesSize, and netAssistantLightweightInfoMsg().

Referenced by setLightweightConns().

void DtAssistantLightweightInfoMsg::setOwnerHostSize ( unsigned  size) [protected, virtual]

Set/Get owning host names text size.

References netAssistantLightweightInfoMsg(), and DtNetAssistantLightweightInfoMsg::ownerHostSize.

Referenced by setLightweightConns().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)