ConnectionParameters#
- class cegalprizm.hub.ConnectionParameters(host: Optional[str] = None, port: Optional[int] = None, use_tls: Optional[bool] = None, use_auth: Optional[bool] = None)#
The connection parameters for communicating with a Cegal Hub Server.
Creates a ConnectionParameters from the given arguments. If not provided the parameters will be set to either local values or created from environment varaiables.
- Parameters
host (str, optional) – the IP address or dns name of the Cegal Hub Server. Defaults to None.
port (int, optional) – the port the CegalHub Server runs on. Typically this would be 9595 for local host or 443 for secure TLS connections. Defaults to None.
use_tls (bool, optional) – indicates that a secure connection to the Cegal Hub Server is required. Defaults to None.
use_auth – indicates that the Python client requires authentication when communicating the Hub Server. Defaults to None.
- property host#
Get the host address of the Cegal Hub Server.
- Returns
The host address of the Cegal Hub Server.
- Return type
str
- property port#
Get the port that the Cegal Hub Server runs on.
- Returns
The port that the Cegal Hub Server runs on.
- Return type
str
- property use_auth#
Whether to use authentication when connecting with the Cegal Hub Server.
- Returns
Whether to use authentication when connecting with the Cegal Hub Server.
- Return type
bool
- property use_tls#
Whether the Cegal Hub Server is running with TLS.
- Returns
Whether the Cegal Hub Server is running with TLS.
- Return type
bool