=====================
Long Running Commands
=====================

.. automodule:: ska_tango_base.long_running_commands

.. note:: 
   The LRC :ref:`client-api` has been moved to its own page, as it will be updated in a future release to be compatible with any SKA Tango command - fast or long running.

.. autoclass:: ska_tango_base.future.LRCMixin
   :members:
   :show-inheritance:

   .. py:attribute:: lrcQueue
      :type: list[str]

      Tango attribute returning a table describing queued long running commands.

      Each element of the list is a JSON object with the following keys:

         - ``"uid"`` - Unique identifier for the command (``str``)
         - ``"name"`` - Name of the command (``str``)
         - ``"submitted_time"`` - Timestamp when the command was submitted (``str``)

   .. py:attribute:: lrcExecuting
      :type: list[str]

      Tango attribute returning a table describing currently executing long running commands.

      Each element of the list is a JSON object with the following keys:

         - ``"uid"`` - Unique identifier for the command (``str``)
         - ``"name"`` - Name of the command (``str``)
         - ``"submitted_time"`` - Timestamp when the command was submitted (``str``)
         - ``"started_time"`` - Timestamp when the command was started (``str``)
         - ``"progress"`` - Percentage completion (optional, ``int``)

   .. py:attribute:: lrcFinished
      :type: list[str]

      Tango attribute returning a table describing finished long running commands.

      Each element of the list is a JSON object with the following keys:

         - ``"uid"`` - Unique identifier for the command (``str``)
         - ``"name"`` - Name of the command (``str``)
         - ``"submitted_time"`` - Timestamp when the command was submitted (``str``)
         - ``"started_time"`` - Timestamp when the command was started (``str``)
         - ``"finished_time"`` - Timestamp when the command finished (``str``)
         - ``"result"`` - JSON encoded result of command (``str``)
         - ``"status"`` - TaskStatus the command finished with (``str``)
         - ``"progress"`` - Percentage completion (optional, ``int``)

.. autoclass:: ska_tango_base.future.AbstractLRCMixin
   :show-inheritance:
   :members:

.. autoclass:: ska_tango_base.future.LRCReqType
   :show-inheritance:
   :members:

Decorators
==========

.. autodecorator:: ska_tango_base.future.long_running_command

.. autodecorator:: ska_tango_base.future.mark_long_running

.. autodecorator:: ska_tango_base.future.submit_lrc_task