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

List of all members.

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.

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)

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 ()

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 
)

Destructor.


Member Function Documentation

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLicServerInfoMsgKind.

Referenced by DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr().

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]

Returns the kind of a DtAssistantLicServerInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantLicServerInfoMsgKind.

Referenced by DtAssistantLicServerInfoMsg().

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.

Referenced by DtAssistantLicenseQueryMgr::processLicServerInfoMsg().

unsigned DtAssistantLicServerInfoMsg::licenseCount ( ) const [protected, virtual]
const DtNetU32 * DtAssistantLicServerInfoMsg::licensePortsPtr ( ) const [protected, virtual]

Return pointer to license ports location in message.

References netAssistantLicServerInfoMsg().

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

DtNetU32 * DtAssistantLicServerInfoMsg::licensePortsPtr ( ) [protected, virtual]
const char * DtAssistantLicServerInfoMsg::licenseServersPtr ( ) const [protected, virtual]

Return pointer to license servers location in message.

References licenseCount(), and licensePortsPtr().

Referenced by getLicenseServers(), and setLicenseServers().

char * DtAssistantLicServerInfoMsg::licenseServersPtr ( ) [protected, virtual]
unsigned long DtAssistantLicServerInfoMsg::licenseServersSize ( ) const [protected, virtual]
int DtAssistantLicServerInfoMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantLicServerInfoMsg().

void DtAssistantLicServerInfoMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantLicServerInfoMsg::setLicenseCount ( unsigned  count) [protected, virtual]

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) [protected, virtual]

Set/Get license servers text size.

References DtNetAssistantLicServerInfoMsg::licenseServersSize, and netAssistantLicServerInfoMsg().

Referenced by setLicenseServers().


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)