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:

Public Member Functions
	DtAssistantLicQueryMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors. More...

	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. More...

virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...

virtual int	port () const
	Get/Set the license server port. More...

virtual void	setPort (int licenseServerPort)

virtual void	setLicenseServerName (const MAKRti::DtString &name, bool adjustBufferSize=true)
	Set/Get server name (adjust buffer size if not pre-allocated for this data). More...

virtual MAKRti::DtString	licenseServerName () const

virtual void	setLicenseServer (const MAKRti::DtString &licServer, bool adjustBufferSize=true)
	Get/Set the entire license server path, the entire string containing the server name and port which is set in the environment variable. More...

virtual MAKRti::DtString	licenseServer () const

virtual bool	isUnlicensed () const
	Get/Set whether unlicensed mode was selected. More...

virtual void	setUnlicensed (bool val)

virtual bool	isAccepted () const
	Get/Set whether the license query resulted in user accepted license server data. More...

virtual void	setAccepted (bool val)

virtual void	printData () const
	Print the data section. More...

Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor. More...

virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation. More...

virtual int	version () const
	Return the message version. More...

virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...

virtual DtAssistantMsgKind	msgKind () const
	Get the message kind. More...

virtual void	print () const
	Printing functions. More...

virtual void	printHeader () const

virtual void	printSrcDest () const

virtual bool	isOk () const
	Message is good? More...

bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants. More...

virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message. More...

virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)

virtual int	sourceId () const
	Get/Set the ID of the source of this message. More...

virtual void	setSourceId (int id)

virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message. More...

virtual void	setSourceHost (const MAKRti::DtString &addr)

virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message. More...

virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)

virtual int	destId () const
	Get/Set the ID of the destination of this message. More...

virtual void	setDestId (int id)

virtual int	compId () const
	Get/Set the related component's connection ID. More...

virtual void	setCompId (int compId)

virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message. More...

virtual void	setSourceUuid (const DtAssistantUuid &uuid)

virtual bool	isForeign () const
	Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only. More...

virtual void	setIsForeign (bool isForeignDestination)

virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only. More...

virtual void	setSequence (DtU32 sequenceNumber)

Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators. More...

static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)

static void	addCallback (DtRtiAssistantServer conn, DtAssistantLicQueryCb cb, void usr)
	Callback management. More...

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)

Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration. More...

Protected Member Functions
virtual DtNetAssistantLicQueryMsg *	netAssistantLicQueryMsg ()
	The network representation. More...

virtual const DtNetAssistantLicQueryMsg *	netAssistantLicQueryMsg () const

virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLicQueryMsg Msg. More...

virtual int	minSize () const
	Returns minimum size of a message, including header. More...

virtual int	minSize (const MAKRti::DtString &name)
	Return the buffer size needed for this message with the given variable data. More...

virtual void	setLicenseServerNameSize (unsigned long size)
	Set/Get server name size. More...

virtual unsigned long	licenseServerNameSize () const

virtual const char *	licenseServerNamePtr () const
	Return pointer to text location in message. More...

virtual char *	licenseServerNamePtr ()

Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor. More...

virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...

void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...

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. More...

virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address. More...

virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. More...

virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message. More...

virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()

virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size. More...

virtual unsigned long	sourceHostSize () const

virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message. More...

virtual char *	sourceHostPtr ()

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.

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

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

virtual DtAssistantLicQueryMsg::~DtAssistantLicQueryMsg ( )

virtual

Destructor.

Member Function Documentation

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

static

Callback management.

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

static

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

virtual

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

Implements DtAssistantMsg.

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

static

Creators.

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

static

virtual DtAssistantMsgKind DtAssistantLicQueryMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantLicQueryMsg Msg.

Implements DtAssistantMsg.

virtual bool DtAssistantLicQueryMsg::isAccepted ( ) const

virtual

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

virtual bool DtAssistantLicQueryMsg::isUnlicensed ( ) const

virtual

Get/Set whether unlicensed mode was selected.

virtual MAKRti::DtString DtAssistantLicQueryMsg::licenseServer ( ) const

virtual

virtual MAKRti::DtString DtAssistantLicQueryMsg::licenseServerName ( ) const

virtual

virtual const char* DtAssistantLicQueryMsg::licenseServerNamePtr ( ) const

protectedvirtual

Return pointer to text location in message.

virtual char* DtAssistantLicQueryMsg::licenseServerNamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLicQueryMsg::licenseServerNameSize ( ) const

protectedvirtual

virtual int DtAssistantLicQueryMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual int DtAssistantLicQueryMsg::minSize ( const MAKRti::DtString & name )

protectedvirtual

Return the buffer size needed for this message with the given variable data.

virtual DtNetAssistantLicQueryMsg* DtAssistantLicQueryMsg::netAssistantLicQueryMsg ( )

protectedvirtual

The network representation.

virtual const DtNetAssistantLicQueryMsg* DtAssistantLicQueryMsg::netAssistantLicQueryMsg ( ) const

protectedvirtual

virtual int DtAssistantLicQueryMsg::port ( ) const

virtual

Get/Set the license server port.

virtual void DtAssistantLicQueryMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

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

static

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

static

virtual void DtAssistantLicQueryMsg::setAccepted ( bool val )

virtual

virtual void DtAssistantLicQueryMsg::setLicenseServer	(	const MAKRti::DtString &	licServer,
		bool	adjustBufferSize = `true`
	)

virtual

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

virtual void DtAssistantLicQueryMsg::setLicenseServerName	(	const MAKRti::DtString &	name,
		bool	adjustBufferSize = `true`
	)

virtual

Set/Get server name (adjust buffer size if not pre-allocated for this data).

virtual void DtAssistantLicQueryMsg::setLicenseServerNameSize ( unsigned long size )

protectedvirtual

Set/Get server name size.

virtual void DtAssistantLicQueryMsg::setPort ( int licenseServerPort )

virtual

virtual void DtAssistantLicQueryMsg::setUnlicensed ( bool val )

virtual

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

assistantLicQueryMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation