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

Public Member Functions

 __init__ (self, comm_descriptor)
 Initializes a new instance with the given communication descriptor.
 
 add_user (self)
 Adds a user to the connection.
 
 remove_user (self)
 Removes a user from the connection.
 
 get_user_count (self)
 Gets the current user count.
 
 get_descriptor (self)
 Gets the descriptor for the connection.
 
 get_ptr_comm (self)
 Gets the TCP communication instance.
 
 get_json_comm (self)
 Gets the JSON communication instance.
 

Constructor & Destructor Documentation

◆ __init__()

JsonMng.JsonConnection.__init__ ( self,
comm_descriptor )

Initializes a new instance with the given communication descriptor.

Parameters
comm_descriptorThe descriptor for the communication.
Returns
An initialized instance of JsonConnection, or nil if the object could not be created.

Member Function Documentation

◆ add_user()

JsonMng.JsonConnection.add_user ( self)

Adds a user to the connection.

Returns
The updated user count.

◆ get_descriptor()

JsonMng.JsonConnection.get_descriptor ( self)

Gets the descriptor for the connection.

Returns
The descriptor string.

◆ get_json_comm()

JsonMng.JsonConnection.get_json_comm ( self)

Gets the JSON communication instance.

Returns
A pointer to the JsonComm instance.

◆ get_ptr_comm()

JsonMng.JsonConnection.get_ptr_comm ( self)

Gets the TCP communication instance.

Returns
A pointer to the TcpComm instance.

◆ get_user_count()

JsonMng.JsonConnection.get_user_count ( self)

Gets the current user count.

Returns
The current user count.

◆ remove_user()

JsonMng.JsonConnection.remove_user ( self)

Removes a user from the connection.

Returns
The updated user count.

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