Previous page

Next page

Locate page in Contents

Print this page

register_client

Summary:

Registers a client with the Agent. Used with count_registered call to implement licensing functionality in the client software.

Request specification:

Name

Min/Max

Type

Description

register_client

 

 

 

{

 

 

 

id

1..1

string

An arbitrary string representing the client ID. For example, this could be some constant string identifying a version of your client software (to limit the number of simultaneous connections from your software to a given Agent).

session_id

1..1

string

Session ID.

}

 

 

 

Returns:

OK/Error

Description:

The register_client call and the count_registered call allow to keep track of the logged in clients and to limit the number of concurrent connections from the same client application to a given Agent. The following describes a typical usage scenario.

As soon as a client establishes a connection with Agent, use the count_registered call to get the number of currently registered clients with the same ID. Depending on the result, one of the following should happen:

It is not necessary to unregister the connection when the client logs off, as Agent does that automatically.

Example:

<packet version="4.0.0" id="2">

<target>sessionm</target>

<data>

<sessionm>

<register_client>

<id>license_id_333</id>

<session_id>vzl.40000.65537.1b7066f2-950e-d142-8a56-dff57c5a305a..5c469223b7t7c5a3d5fr1bb8</session_id>

</register_client>

</sessionm>

</data>

</packet>

Please send us your feedback on this help page