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. The ID is used to identify the client software from which the connection has been initiated.

}

 

 

 

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 software to the Agent. You can use this functionality to implement a licensing policy where only a certain number of instances of your client software can be connected to the Agent at the same time. The following describes a typical usage scenario.

As soon as a client establishes a connection with the 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.

Please note that this call is used to count the permanent connections only. To count the user sessions, use the sessionm/register_client call.

Example:

<packet version="4.0.0">

<data>

<system>

<register_client>

<id>My_Agent_Application</id>

</register_client>

</system>

</data>

</packet>

Please send us your feedback on this help page