The DtAssistantLicQueryMsg defines a wrapper for the messages sent to and from the Assistant to query for license information and respond with the license information. More...

Inheritance diagram for DtAssistantLicQueryMsg:

Collaboration diagram for DtAssistantLicQueryMsg:

List of all members.

Public Member Functions
	DtAssistantLicQueryMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantLicQueryMsg (const DtNetAssistantLicQueryMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantLicQueryMsg (const MAKRti::DtString &serverName, int port, bool accepted, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantLicQueryMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual int	port () const
	Get/Set the license server port.
virtual void	setPort (int licenseServerPort)
virtual void	setLicenseServerName (const MAKRti::DtString &name)
	Set/Get server name.
virtual MAKRti::DtString	licenseServerName () const
virtual void	setLicenseServer (const MAKRti::DtString &licServer)
	Get/Set the entire license server path, the entire string containing the server name and port which is set in the environment variable.
virtual MAKRti::DtString	licenseServer () const
virtual bool	isUnlicensed () const
	Get/Set whether unlicensed mode was selected.
virtual void	setUnlicensed (bool val)
virtual bool	isAccepted () const
	Get/Set whether the license query resulted in user accepted license server data.
virtual void	setAccepted (bool val)
virtual void	printData () const
	Print the data section.
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantLicQueryCb cb, void usr)
	Callback management.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantLicQueryCb cb, void usr)
static void	addCallback (DtAssistantMsgQueue queue, DtAssistantLicQueryCb cb, void usr)
static void	removeCallback (DtAssistantMsgQueue queue, DtAssistantLicQueryCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantLicQueryMsg *	netAssistantLicQueryMsg ()
	The network representation.
virtual const DtNetAssistantLicQueryMsg *	netAssistantLicQueryMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLicQueryMsg Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	setMinSize (const MAKRti::DtString &name)
	Sets the field sizes for the variant components and returns the minimum size needed for the message, including header.
virtual void	setLicenseServerNameSize (unsigned long size)
	Set/Get server name size.
virtual unsigned long	licenseServerNameSize () const
virtual const char *	licenseServerNamePtr () const
	Return pointer to text location in message.
virtual char *	licenseServerNamePtr ()

Detailed Description

The DtAssistantLicQueryMsg defines a wrapper for the messages sent to and from the Assistant to query for license information and respond with the license information.

Constructor & Destructor Documentation

DtAssistantLicQueryMsg::DtAssistantLicQueryMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantLicQueryMsg::DtAssistantLicQueryMsg	(	const DtNetAssistantLicQueryMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtNetAssistantLicQueryMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantLicQueryMsg::DtAssistantLicQueryMsg	(	const MAKRti::DtString &	serverName,
		int	port,
		bool	accepted,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), setAccepted(), setLicenseServerName(), setMinSize(), and setPort().

DtAssistantLicQueryMsg::~DtAssistantLicQueryMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantLicQueryMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLicQueryCb	cb,
		void *	usr
	)		`[static]`

Callback management.

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantLicQueryMsgKind.

Referenced by DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr().

void DtAssistantLicQueryMsg::addCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantLicQueryCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantMsgQueue::addMsgCallback(), and DtAssistantLicQueryMsgKind.

DtAssistantMsg * DtAssistantLicQueryMsg::clone ( bool copy = true ) const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantLicQueryMsg(), and netAssistantLicQueryMsg().

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

Creators.

References DtAssistantLicQueryMsg().

DtAssistantMsg * DtAssistantLicQueryMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER ) [static]

References DtAssistantLicQueryMsg().

DtAssistantMsgKind DtAssistantLicQueryMsg::internalMsgKind ( ) [protected, virtual]

Returns the kind of a DtAssistantLicQueryMsg Msg.

Implements DtAssistantMsg.

References DtAssistantLicQueryMsgKind.

Referenced by DtAssistantLicQueryMsg().

bool DtAssistantLicQueryMsg::isAccepted ( ) const [virtual]

Get/Set whether the license query resulted in user accepted license server data.

References DtNetAssistantLicQueryMsg::accepted, and netAssistantLicQueryMsg().

Referenced by printData(), and DtRtiAssistantClient::sendLicQueryMsg().

bool DtAssistantLicQueryMsg::isUnlicensed ( ) const [virtual]

Get/Set whether unlicensed mode was selected.

References netAssistantLicQueryMsg(), and DtNetAssistantLicQueryMsg::unlicensed.

Referenced by printData(), DtAssistantLicenseQueryMgr::processLicQueryMsg(), and DtRtiAssistantClient::sendLicQueryMsg().

DtString DtAssistantLicQueryMsg::licenseServer ( ) const [virtual]

References licenseServerName(), and port().

Referenced by DtRtiAssistantClient::sendLicQueryMsg().

DtString DtAssistantLicQueryMsg::licenseServerName ( ) const [virtual]

References licenseServerNamePtr(), and licenseServerNameSize().

Referenced by licenseServer(), printData(), and DtAssistantLicenseQueryMgr::processLicQueryMsg().

const char * DtAssistantLicQueryMsg::licenseServerNamePtr ( ) const [protected, virtual]

Return pointer to text location in message.

References netAssistantLicQueryMsg().

Referenced by licenseServerName(), and setLicenseServerName().

char * DtAssistantLicQueryMsg::licenseServerNamePtr ( ) [protected, virtual]

References netAssistantLicQueryMsg().

unsigned long DtAssistantLicQueryMsg::licenseServerNameSize ( ) const [protected, virtual]

References DtNetAssistantLicQueryMsg::licenseServerNameSize, and netAssistantLicQueryMsg().

Referenced by licenseServerName(), setLicenseServerName(), and setMinSize().

int DtAssistantLicQueryMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantLicQueryMsg().

DtNetAssistantLicQueryMsg * DtAssistantLicQueryMsg::netAssistantLicQueryMsg ( ) [protected, virtual]

The network representation.

Referenced by clone(), isAccepted(), isUnlicensed(), licenseServerNamePtr(), licenseServerNameSize(), port(), setAccepted(), setLicenseServerNameSize(), setPort(), and setUnlicensed().

const DtNetAssistantLicQueryMsg * DtAssistantLicQueryMsg::netAssistantLicQueryMsg ( ) const [protected, virtual]

int DtAssistantLicQueryMsg::port ( ) const [virtual]

Get/Set the license server port.

References netAssistantLicQueryMsg(), and DtNetAssistantLicQueryMsg::port.

Referenced by licenseServer(), printData(), DtAssistantLicenseQueryMgr::processLicQueryMsg(), setLicenseServer(), and setPort().

void DtAssistantLicQueryMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References isAccepted(), isUnlicensed(), licenseServerName(), and port().

void DtAssistantLicQueryMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLicQueryCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantLicQueryMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantLicenseQueryMgr::~DtAssistantLicenseQueryMgr().

void DtAssistantLicQueryMsg::removeCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantLicQueryCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantLicQueryMsgKind, and DtAssistantMsgQueue::removeMsgCallback().

void DtAssistantLicQueryMsg::setAccepted ( bool val ) [virtual]

References DtNetAssistantLicQueryMsg::accepted, and netAssistantLicQueryMsg().

Referenced by DtAssistantLicQueryMsg(), and DtRtiAssistantServer::sendLicRespMsg().

void DtAssistantLicQueryMsg::setLicenseServer ( const MAKRti::DtString & licServer ) [virtual]

Get/Set the entire license server path, the entire string containing the server name and port which is set in the environment variable.

References port(), setLicenseServerName(), and setPort().

void DtAssistantLicQueryMsg::setLicenseServerName ( const MAKRti::DtString & name ) [virtual]

Set/Get server name.

References rti1516e::insertBytes(), licenseServerNamePtr(), licenseServerNameSize(), and setLicenseServerNameSize().

Referenced by DtAssistantLicQueryMsg(), DtRtiAssistantServer::sendLicRespMsg(), and setLicenseServer().

void DtAssistantLicQueryMsg::setLicenseServerNameSize ( unsigned long size ) [protected, virtual]

Set/Get server name size.

References DtNetAssistantLicQueryMsg::licenseServerNameSize, and netAssistantLicQueryMsg().

Referenced by setLicenseServerName(), and setMinSize().

int DtAssistantLicQueryMsg::setMinSize ( const MAKRti::DtString & name ) [protected, virtual]

Sets the field sizes for the variant components and returns the minimum size needed for the message, including header.

DOES NOT allocate memory for the components.

References licenseServerNameSize(), and setLicenseServerNameSize().

Referenced by DtAssistantLicQueryMsg().

void DtAssistantLicQueryMsg::setPort ( int licenseServerPort ) [virtual]

References netAssistantLicQueryMsg(), DtNetAssistantLicQueryMsg::port, and port().

Referenced by DtAssistantLicQueryMsg(), DtRtiAssistantServer::sendLicRespMsg(), and setLicenseServer().

void DtAssistantLicQueryMsg::setUnlicensed ( bool val ) [virtual]

References netAssistantLicQueryMsg(), and DtNetAssistantLicQueryMsg::unlicensed.

Referenced by DtRtiAssistantClient::sendLicQueryMsg(), and DtRtiAssistantServer::sendLicRespMsg().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation