UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
JsonMng.JsonCommController Class Reference

Public Member Functions

 __init__ (self)
 Initializes the JsonCommController.
 
 create_mgmt_comm_with_comm_descriptor (self, comm_descriptor)
 Creates a management communication instance with the given communication descriptor.
 
 release_mgmt_comm_with_comm_descriptor (self, comm_descriptor)
 Releases a management communication instance with the given communication descriptor.
 
 user_count_for_comm_descriptor (self, comm_descriptor)
 Gets the user count for the given communication descriptor.
 
 connection_count (self)
 Gets the total number of active connections.
 
 descriptors (self)
 Gets an array of all communication descriptors.
 

Public Attributes

 active_comms
 

Constructor & Destructor Documentation

◆ __init__()

JsonMng.JsonCommController.__init__ ( self)

Initializes the JsonCommController.

Member Function Documentation

◆ connection_count()

JsonMng.JsonCommController.connection_count ( self)

Gets the total number of active connections.

Returns
The total number of connections.

◆ create_mgmt_comm_with_comm_descriptor()

JsonMng.JsonCommController.create_mgmt_comm_with_comm_descriptor ( self,
comm_descriptor )

Creates a management communication instance with the given communication descriptor.

Parameters
comm_descriptorThe descriptor for the communication instance.
Returns
A new JsonComm instance.

◆ descriptors()

JsonMng.JsonCommController.descriptors ( self)

Gets an array of all communication descriptors.

Returns
An array of strings representing the communication descriptors.

◆ release_mgmt_comm_with_comm_descriptor()

JsonMng.JsonCommController.release_mgmt_comm_with_comm_descriptor ( self,
comm_descriptor )

Releases a management communication instance with the given communication descriptor.

Parameters
comm_descriptorThe descriptor for the communication instance to be released.

◆ user_count_for_comm_descriptor()

JsonMng.JsonCommController.user_count_for_comm_descriptor ( self,
comm_descriptor )

Gets the user count for the given communication descriptor.

Parameters
comm_descriptorThe descriptor for the communication instance.
Returns
The number of users for the specified communication instance.

Member Data Documentation

◆ active_comms

JsonMng.JsonCommController.active_comms

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