MAK RTIspy API Documentation for HLA Evolved
 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
DtAssistantLicServerInfoMsg Class Reference

The DtAssistantLicServerInfoMsg defines a wrapper for the RTI Assistant information message used by the Assistants to share known license server information with one another. More...

+ Inheritance diagram for DtAssistantLicServerInfoMsg:
+ Collaboration diagram for DtAssistantLicServerInfoMsg:

Public Member Functions

 DtAssistantLicServerInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantLicServerInfoMsg (const DtNetAssistantLicServerInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantLicServerInfoMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setLicenseServers (const DtLicServerSet &licenseServers)
 Set/Get license servers.
virtual void getLicenseServers (DtLicServerSet &servers) 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 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, DtAssistantLicServerInfoCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantLicServerInfoCb 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
DtNetAssistantLicServerInfoMsg
netAssistantLicServerInfoMsg ()
 The network representation for the message.
virtual const
DtNetAssistantLicServerInfoMsg
netAssistantLicServerInfoMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantLicServerInfoMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setLicenseCount (unsigned count)
 Set/Get number of license servers included in message.
virtual unsigned licenseCount () const
virtual const DtNetU32 * licensePortsPtr () const
 Return pointer to license ports location in message.
virtual DtNetU32 * licensePortsPtr ()
virtual void setLicenseServersSize (unsigned long size)
 Set/Get license servers text size.
virtual unsigned long licenseServersSize () const
virtual const char * licenseServersPtr () const
 Return pointer to license servers location in message.
virtual char * licenseServersPtr ()
- 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 DtAssistantLicServerInfoMsg defines a wrapper for the RTI Assistant information message used by the Assistants to share known license server information with one another.

Constructor & Destructor Documentation

DtAssistantLicServerInfoMsg::DtAssistantLicServerInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone(), and create().

DtAssistantLicServerInfoMsg::DtAssistantLicServerInfoMsg ( const DtNetAssistantLicServerInfoMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantLicServerInfoMsg::~DtAssistantLicServerInfoMsg ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantLicServerInfoMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantLicServerInfoCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLicServerInfoMsgKind.

Referenced by DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr().

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

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

Implements DtAssistantMsg.

References DtAssistantLicServerInfoMsg(), and netAssistantLicServerInfoMsg().

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

Creators.

References DtAssistantLicServerInfoMsg().

DtAssistantMsg * DtAssistantLicServerInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
void DtAssistantLicServerInfoMsg::getLicenseServers ( DtLicServerSet servers) const
virtual
DtAssistantMsgKind DtAssistantLicServerInfoMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantLicServerInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantLicServerInfoMsgKind.

Referenced by DtAssistantLicServerInfoMsg().

bool DtAssistantLicServerInfoMsg::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 netAssistantLicServerInfoMsg(), and DtNetAssistantLicServerInfoMsg::removal.

unsigned DtAssistantLicServerInfoMsg::licenseCount ( ) const
protectedvirtual
const DtNetU32 * DtAssistantLicServerInfoMsg::licensePortsPtr ( ) const
protectedvirtual

Return pointer to license ports location in message.

References netAssistantLicServerInfoMsg().

Referenced by getLicenseServers(), licenseServersPtr(), and setLicenseServers().

DtNetU32 * DtAssistantLicServerInfoMsg::licensePortsPtr ( )
protectedvirtual
const char * DtAssistantLicServerInfoMsg::licenseServersPtr ( ) const
protectedvirtual

Return pointer to license servers location in message.

References licenseCount(), and licensePortsPtr().

Referenced by getLicenseServers(), and setLicenseServers().

char * DtAssistantLicServerInfoMsg::licenseServersPtr ( )
protectedvirtual
unsigned long DtAssistantLicServerInfoMsg::licenseServersSize ( ) const
protectedvirtual
int DtAssistantLicServerInfoMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantLicServerInfoMsg().

DtNetAssistantLicServerInfoMsg * DtAssistantLicServerInfoMsg::netAssistantLicServerInfoMsg ( )
protectedvirtual
const DtNetAssistantLicServerInfoMsg * DtAssistantLicServerInfoMsg::netAssistantLicServerInfoMsg ( ) const
protectedvirtual
void DtAssistantLicServerInfoMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantLicServerInfoMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantLicServerInfoCb  cb,
void *  usr 
)
static
void DtAssistantLicServerInfoMsg::setLicenseCount ( unsigned  count)
protectedvirtual

Set/Get number of license servers included in message.

References DtNetAssistantLicServerInfoMsg::licenseCount, and netAssistantLicServerInfoMsg().

Referenced by setLicenseServers().

void DtAssistantLicServerInfoMsg::setLicenseServers ( const DtLicServerSet licenseServers)
virtual
void DtAssistantLicServerInfoMsg::setLicenseServersSize ( unsigned long  size)
protectedvirtual

Set/Get license servers text size.

References DtNetAssistantLicServerInfoMsg::licenseServersSize, and netAssistantLicServerInfoMsg().

Referenced by setLicenseServers().

void DtAssistantLicServerInfoMsg::setRemoval ( bool  val)
virtual

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

Document ID: Generated on Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)