The `client.py` module#

Summary#

Classes

Provides the client object for interacting with the Rocky/Freeflow app.

Functions

`connect`	Connect to a Rocky/Freeflow app instance.
`connect_to_rocky`	This function is deprecated.

Constants

`PYROCKY_DEFAULT_PORT`
`DEFAULT_SERVER_PORT`

Module that defines the RockyClient class, which acts as a proxy for a Rocky application session.

client.connect(host: str | None = None, port: int = PYROCKY_DEFAULT_PORT) → RockyClient#

Connect to a Rocky/Freeflow app instance.

Parameters:

hoststr, optional: Host name where the app is running. On Windows, default is "localhost". On Linux, it defaults to a unix domain socket connection.
portint, optional: Service port to connect to.
Returns
——-
RockyClient: Client object for interacting with the Rocky/Freeflow app.

client.connect_to_rocky(host: str | None = None, port: int = PYROCKY_DEFAULT_PORT) → RockyClient#: This function is deprecated. Use connect() instead.