Summary:
Provides information about the clients that are currently registered with the Agent. Used with the register_client
call to implement licensing functionality in the client software.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
|
|
|
|
|
|
|
The ID of the client to retrieve the connection info for. If the element is omitted, the information for all registered clients will be retrieved. The ID is assigned to the client connection at the time it is registered with the Agent using the |
|
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
|
Client connection information. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Description:
The count_registered
call and the register_client
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 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:
register_client
call. 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/count_registered
call.
Example:
Input
<packet version="4.0.0">
<data>
<system>
<count_registered/>
</system>
</data>
</packet>
Output
<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/system" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="51c467017bct323bra18" priority="0" version="4.0.0">
<ns1:origin>gend</ns1:origin>
<ns1:target>vzclient62-638a2a56-e689-c340-877d-bd0470f2448c</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns1:system>
<ns2:registered>
<ns2:id>license_id_333</ns2:id>
<ns2:count>1</ns2:count>
</ns2:registered>
<ns2:registered>
<ns2:id>license_id_334</ns2:id>
<ns2:count>1</ns2:count>
</ns2:registered>
<ns2:registered>
<ns2:id>license_id_335</ns2:id>
<ns2:count>2</ns2:count>
</ns2:registered>
</ns1:system>
</ns1:data>
</ns1:packet>