.. py:module:: ansys.rocky.core.client


Summary
-------










.. py:currentmodule:: client
.. tab-set::




    .. tab-item:: Classes

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~RockyClient`
            - Provides the client object for interacting with the Rocky app.





    .. tab-item:: Functions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~connect_to_rocky`
            - Connect to a Rocky app instance.




    .. tab-item:: Constants

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~DEFAULT_SERVER_PORT`
            - 












Description
-----------

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

..
    !! processed by numpydoc !!






Module detail
-------------



.. py:class:: RockyClient(rocky_api)

   
   Provides the client object for interacting with the Rocky app.


   :Parameters:

       **rocky_api** : :obj:`Pyro5.api.Proxy`
           Pyro5 proxy object for interacting with the Rocky app.














   ..
       !! processed by numpydoc !!


.. py:currentmodule:: RockyClient

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~close`
            - 


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~api`
            - 







Import detail
-------------

.. code-block:: python

    from ansys.rocky.core.client import RockyClient

Property detail
---------------
.. py:property:: api






Method detail
-------------
.. py:method:: close()




.. py:function:: connect_to_rocky(host: str = 'localhost', port: int = DEFAULT_SERVER_PORT) -> RockyClient

   
   Connect to a Rocky app instance.


   :Parameters:

       **host** : :class:`python:str`, :obj:`optional`
           Host name where the app is running. The default is ``"localhost"``.

       **port** : :class:`python:int`, :obj:`optional`
           Service port to connect to. The default is ``DEFAULT_SERVER_PORT``,
           which is 50615.

   :Returns:

       :obj:`RockyClient`
           Client object for interacting with the Rocky app.













   ..
       !! processed by numpydoc !!

.. py:data:: DEFAULT_SERVER_PORT
   :type: Final[int]
   :value: 50615