pyrcf.utils.data_io_utils.pyrcf_subscriber
==========================================

.. py:module:: pyrcf.utils.data_io_utils.pyrcf_subscriber


Classes
-------

.. autoapisummary::

   pyrcf.utils.data_io_utils.pyrcf_subscriber.PyRCFSubscriberBase
   pyrcf.utils.data_io_utils.pyrcf_subscriber.PyRCFSubscriberZMQ


Module Contents
---------------

.. py:class:: PyRCFSubscriberBase

   Bases: :py:obj:`abc.ABC`


   Base subscriber class.


   .. py:method:: read_raw() -> str
      :abstractmethod:


      Return raw string/bytes.



   .. py:method:: read_json() -> Mapping[str, Any]

      Return as python dict (json).



   .. py:method:: close()

      Close subscriber cleanly.



.. py:class:: PyRCFSubscriberZMQ(port: int = DEFAULT_ZMQ_PUBLISH_PORT, topic: str = '')

   Bases: :py:obj:`PyRCFSubscriberBase`


   A zmq subscriber to read data published using `PyRCFPublisherZMQ`.


   .. py:attribute:: context


   .. py:attribute:: socket


   .. py:method:: read_raw() -> str

      Return raw string/bytes.



   .. py:method:: close()

      Close subscriber cleanly.



   .. py:method:: __del__()