===========================
SKA Tango Event Monitor API
===========================

.. automodule:: ska_tango_event_monitor

QueryEventSystem response parsing
---------------------------------

:func:`QueryEventSystemResponse.from_json` can be used to parse the result of the :func:`!QueryEventSystem()` device server command into a python data class object.  For example

.. code :: python

   >>> response = QueryEventSystemResponse.from_json(json.loads(admin_device_proxy.QueryEventSystem()))

.. autoclass:: ska_tango_event_monitor.QueryEventSystemResponse
   :members:

.. autoclass:: ska_tango_event_monitor.ServerResponse
   :members:

.. autoclass:: ska_tango_event_monitor.ServerPerfSample
   :members:

.. autoclass:: ska_tango_event_monitor.ClientResponse
   :members:

.. autoclass:: ska_tango_event_monitor.EventCallback
   :members:

.. autoclass:: ska_tango_event_monitor.DisconnectedEventStream
   :members:

.. autoclass:: ska_tango_event_monitor.EventChannel
   :members:

.. autoclass:: ska_tango_event_monitor.ClientPerfSample
   :members:

Summary computation
-------------------

:func:`ResponseChangeSummary.from_responses` can be used to compare subsequent responses from the :func:`!QueryEventSystem()` device server command.  For example, to compute the changes over a 10 second period:

.. code :: python

   >>> first = QueryEventSystemResponse.from_json(json.loads(admin_device_proxy.QueryEventSystem()))
   >>> time.sleep(10)
   >>> second = QueryEventSystemResponse.from_json(json.loads(admin_device_proxy.QueryEventSystem()))
   >>> change_summary = ResponseChangeSummary.from_responses(seconds, first)

.. autoclass:: ska_tango_event_monitor.ResponseChangeSummary
   :members:

.. autoclass:: ska_tango_event_monitor.ServerSummary
   :members:

.. autoclass:: ska_tango_event_monitor.ServerDiff
   :members:

.. autoclass:: ska_tango_event_monitor.ServerPerfSummary
   :members:

.. autoclass:: ska_tango_event_monitor.ClientSummary
   :members:

.. autoclass:: ska_tango_event_monitor.ClientDiff
   :members:

.. autoclass:: ska_tango_event_monitor.ClientPerfSummary
   :members:

.. autoclass:: ska_tango_event_monitor.NewSubscriptionState
   :members:

.. autoclass:: ska_tango_event_monitor.ChangedSubscriptionState
   :members:

.. autoclass:: ska_tango_event_monitor.StatsSummary
   :members:

.. autoclass:: ska_tango_event_monitor.Quantiles
   :members: