gs::TGSRequest Class Reference

Request Object. More...

Inheritance diagram for gs::TGSRequest:

[legend]

Collaboration diagram for gs::TGSRequest:

[legend]

Public Member Functions
TGSAction *	addAction (action_id_t actId)
	adds a global action targeting all entities More...
TGSAction *	addAction (action_id_t actId, TGSEntity *entity)
	adds an action targeting all licenses of an entity More...
TGSAction *	addAction (action_id_t actId, TGSLicense *license)
	adds an action targeting a single license object More...
TGSAction *	addAction (action_id_t actId, const char *entityId, const char *licenseId)
	adds an action targeting a single license object More...
const char *	code ()
	gets the request string code More...
Public Member Functions inherited from gs::TGSObject
gs_handle_t	handle () const
	Gets GS5 object handle.

Detailed Description

Request Object.

Request object hosts all desired actions to be applied to local license.

When a request (its request code) is sent to server its content is double-checked by server logic, and once approved, a corresponding license code (also known as activation code) is returned to authorize the action(s) applying to modify local license status.

The server (or gsKeyGenerator) might modify the contained action(s) to enforce license requirement;

Request object also contains client side fingerprint information, so even it contains no action, the request code can also be used to sampling client machine's hardware information, and if necessary, the server side can generate license code targeting the client's machine without a request code.

Member Function Documentation

TGSAction * gs::TGSRequest::addAction

(

action_id_t

actId

)

adds a global action targeting all entities

Adds an action targeting the whole license storage (ACT_CLEAN), or can be applied to all entities( ACT_LOCK, ACT_UNLOCK, etc.)

TGSAction * gs::TGSRequest::addAction	(	action_id_t	actId,
		TGSEntity *	entity
	)

adds an action targeting all licenses of an entity

Parameters

actId	Action type id;
entity	the target entity, the action will be applied to all licenses attached to the entity.

Returns

the pointer to action object, NULL if the action type id is not supported.

TGSAction * gs::TGSRequest::addAction	(	action_id_t	actId,
		TGSLicense *	license
	)

adds an action targeting a single license object

Parameters

actId	Action type id;
license	the target license object to which the action will be applied to;

Returns

the pointer to action object, NULL if the action type id is not supported.

TGSAction * gs::TGSRequest::addAction	(	action_id_t	actId,
		const char *	entityId,
		const char *	licenseId
	)

adds an action targeting a single license object

Parameters

actId	Action type id;
entityId	the target entity id to which the target license is attached;
licenseId	the target license id to which the action will be applied to;

Returns

the pointer to action object, NULL if the action type id is not supported.

const char * gs::TGSRequest::code

(

)

gets the request string code

Ref: Request Code