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

The DtAssistantAwaitingForwardersMsg defines a wrapper for the RTI Assistant message sent to an assistant from a local RTI Forwarder to its Assistant to inform it that it is waiting for connections from other RTI Forwarders. More...

+ Inheritance diagram for DtAssistantAwaitingForwardersMsg:
+ Collaboration diagram for DtAssistantAwaitingForwardersMsg:

Public Member Functions

 DtAssistantAwaitingForwardersMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantAwaitingForwardersMsg (const DtNetAssistantAwaitingForwardersMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantAwaitingForwardersMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print the data section.
void getForwarders (DtNeededFwConnMap &fws) const
 Get the list of forwarder connections.
void setForwarders (const DtNeededFwConnMap &fws)
 Set the list of forwarder connections.
bool isWaitingForForwarders () const
 Get whether the forwarder is waiting for forwarder-to-forwarder connections.
void setIsWaitingForForwarders (bool isWaiting)
 Set whether the forwarder is waiting for forwarder-to-forwarder connections.
unsigned int numForwarders () const
 Returns the number of forwarder connections.
- 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, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtRtiAssistantServer *conn, DtAssistantAwaitingForwardersCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantAwaitingForwardersCb cb, void *usr)
static void addCallback (DtRtiAssistantClient *conn, DtAssistantAwaitingForwardersCb cb, void *usr)
 Adds or removes a callback with the given Assistant client for this message type.
static void removeCallback (DtRtiAssistantClient *conn, DtAssistantAwaitingForwardersCb 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
DtNetAssistantAwaitingForwardersMsg
netAssistantAwaitingForwardersMsg ()
 The network representation for the message.
virtual const
DtNetAssistantAwaitingForwardersMsg
netAssistantAwaitingForwardersMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtNetAssistantAwaitingForwardersMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual const DtNetU128 * forwarderAddrsPtr () const
 Get the pointer to the forwarder addresses data.
virtual DtNetU128 * forwarderAddrsPtr ()
virtual const DtNetU16 * forwarderPortsPtr () const
 Get the pointer to the forwarder ports data.
virtual DtNetU16 * forwarderPortsPtr ()
virtual unsigned int forwarderNamesSize () const
 Get/Set the total size of all the forwarder names.
virtual void setForwarderNamesSize (unsigned int size)
virtual const char * forwarderNamesPtr () const
 Get the pointer to the forwarder names data.
virtual char * forwarderNamesPtr ()
const DtNetU8 * forwarderConnectedPtr () const
 Get the pointer to connection status data for the forwarders.
DtNetU8 * forwarderConnectedPtr ()
- 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 ()

Detailed Description

The DtAssistantAwaitingForwardersMsg defines a wrapper for the RTI Assistant message sent to an assistant from a local RTI Forwarder to its Assistant to inform it that it is waiting for connections from other RTI Forwarders.

Constructor & Destructor Documentation

DtAssistantAwaitingForwardersMsg::DtAssistantAwaitingForwardersMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone().

DtAssistantAwaitingForwardersMsg::DtAssistantAwaitingForwardersMsg ( const DtNetAssistantAwaitingForwardersMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantAwaitingForwardersMsg::~DtAssistantAwaitingForwardersMsg ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantAwaitingForwardersMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantAwaitingForwardersCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantAwaitingForwardersMsgKind.

Referenced by DtAssistantFederationsViewMgr::DtAssistantFederationsViewMgr().

void DtAssistantAwaitingForwardersMsg::addCallback ( DtRtiAssistantClient conn,
DtAssistantAwaitingForwardersCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantAwaitingForwardersMsgKind.

DtAssistantMsg * DtAssistantAwaitingForwardersMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

References DtAssistantAwaitingForwardersMsg(), and netAssistantAwaitingForwardersMsg().

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

Creators.

static DtAssistantMsg* DtAssistantAwaitingForwardersMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
const DtNetU128 * DtAssistantAwaitingForwardersMsg::forwarderAddrsPtr ( ) const
protectedvirtual

Get the pointer to the forwarder addresses data.

References netAssistantAwaitingForwardersMsg().

Referenced by forwarderPortsPtr(), getForwarders(), and setForwarders().

DtNetU128 * DtAssistantAwaitingForwardersMsg::forwarderAddrsPtr ( )
protectedvirtual
const DtNetU8 * DtAssistantAwaitingForwardersMsg::forwarderConnectedPtr ( ) const
protected

Get the pointer to connection status data for the forwarders.

References forwarderNamesPtr(), and forwarderNamesSize().

Referenced by getForwarders(), and setForwarders().

DtNetU8 * DtAssistantAwaitingForwardersMsg::forwarderConnectedPtr ( )
protected
const char * DtAssistantAwaitingForwardersMsg::forwarderNamesPtr ( ) const
protectedvirtual

Get the pointer to the forwarder names data.

References forwarderPortsPtr(), and numForwarders().

Referenced by forwarderConnectedPtr(), getForwarders(), and setForwarders().

char * DtAssistantAwaitingForwardersMsg::forwarderNamesPtr ( )
protectedvirtual
unsigned int DtAssistantAwaitingForwardersMsg::forwarderNamesSize ( ) const
protectedvirtual

Get/Set the total size of all the forwarder names.

References DtNetAssistantAwaitingForwardersMsg::fwNamesSize, and netAssistantAwaitingForwardersMsg().

Referenced by forwarderConnectedPtr(), and setForwarders().

const DtNetU16 * DtAssistantAwaitingForwardersMsg::forwarderPortsPtr ( ) const
protectedvirtual

Get the pointer to the forwarder ports data.

References forwarderAddrsPtr(), and numForwarders().

Referenced by forwarderNamesPtr(), getForwarders(), and setForwarders().

DtNetU16 * DtAssistantAwaitingForwardersMsg::forwarderPortsPtr ( )
protectedvirtual
void DtAssistantAwaitingForwardersMsg::getForwarders ( DtNeededFwConnMap fws) const
DtAssistantMsgKind DtAssistantAwaitingForwardersMsg::internalMsgKind ( )
protectedvirtual
bool DtAssistantAwaitingForwardersMsg::isWaitingForForwarders ( ) const

Get whether the forwarder is waiting for forwarder-to-forwarder connections.

References DtNetAssistantAwaitingForwardersMsg::isWaiting, and netAssistantAwaitingForwardersMsg().

Referenced by printData(), and DtAssistantFederationsViewMgr::processAwaitingForwardersMsg().

int DtAssistantAwaitingForwardersMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantAwaitingForwardersMsg().

DtNetAssistantAwaitingForwardersMsg * DtAssistantAwaitingForwardersMsg::netAssistantAwaitingForwardersMsg ( )
protectedvirtual
const DtNetAssistantAwaitingForwardersMsg * DtAssistantAwaitingForwardersMsg::netAssistantAwaitingForwardersMsg ( ) const
protectedvirtual
unsigned int DtAssistantAwaitingForwardersMsg::numForwarders ( ) const
void DtAssistantAwaitingForwardersMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References isWaitingForForwarders(), and numForwarders().

void DtAssistantAwaitingForwardersMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantAwaitingForwardersCb  cb,
void *  usr 
)
static
void DtAssistantAwaitingForwardersMsg::removeCallback ( DtRtiAssistantClient conn,
DtAssistantAwaitingForwardersCb  cb,
void *  usr 
)
static
void DtAssistantAwaitingForwardersMsg::setForwarderNamesSize ( unsigned int  size)
protectedvirtual
void DtAssistantAwaitingForwardersMsg::setForwarders ( const DtNeededFwConnMap fws)
void DtAssistantAwaitingForwardersMsg::setIsWaitingForForwarders ( bool  isWaiting)

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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)