Summary#

RockyClient

Provides the client object for interacting with the Rocky app.

connect_to_rocky

Connect to a Rocky app instance.

DEFAULT_SERVER_PORT

Description#

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

Module detail#

class client.RockyClient(rocky_api)#

Provides the client object for interacting with the Rocky app.

Parameters:
rocky_apiPyro5.api.Proxy

Pyro5 proxy object for interacting with the Rocky app.

Overview#

close

api

Import detail#

from ansys.rocky.core.client import RockyClient

Property detail#

property RockyClient.api#

Method detail#

RockyClient.close()#
RockyClient.connect_to_rocky(host: str = 'localhost', port: int = DEFAULT_SERVER_PORT) → RockyClient#

Connect to a Rocky app instance.

Parameters:
hoststr, optional

Host name where the app is running. The default is "localhost".

portint, optional

Service port to connect to. The default is DEFAULT_SERVER_PORT, which is 50615.

Returns:
RockyClient

Client object for interacting with the Rocky app.

RockyClient.DEFAULT_SERVER_PORT: Final[int] = 50615#