snews_pt.remote_commands
========================

.. py:module:: snews_pt.remote_commands

.. autoapi-nested-parse::

   Easy handle remote commands


   Melih Kara, kara@kit.edu



Functions
---------

.. autoapisummary::

   snews_pt.remote_commands.test_connection
   snews_pt.remote_commands.write_hb_logs
   snews_pt.remote_commands.reset_cache
   snews_pt.remote_commands.change_broker
   snews_pt.remote_commands.get_feedback


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

.. py:function:: test_connection(detector_name=None, firedrill=True, start_at='LATEST', patience=8)

   test the server connection
   It should prompt your whether the
   coincidence script is running in the server

   :param start_at: Where hop starts looking for messages can either be  "LATEST" or "EARLIEST"
   :type start_at: str
   :param patience: Seconds to wait before the check
   :type patience: int

   :rtype: None


.. py:function:: write_hb_logs(detector_name=None, admin_pass=None, firedrill=True)

   Ask server to print the heartbeat logs on the server as standard output
   later admins can see them remotely. Requires admin password

   :param detector_name: Name of the detector requesting the write operation
   :type detector_name: str
   :param admin_pass: Simple password as a string
   :type admin_pass: str
   :param firedrill: Whether to use the firedrill broker
   :type firedrill: bool


.. py:function:: reset_cache(detector_name=None, admin_pass=None, firedrill=True, is_test=True)

   If authorized, drop the current cache at the server

   :param detector_name: Name of the detector
   :type detector_name: str
   :param admin_pass: Simple password as a string
   :type admin_pass: str
   :param firedrill: Whether to use the firedrill broker
   :type firedrill: bool


.. py:function:: change_broker(brokername, detector_name=None, admin_pass=None, firedrill=True)

   If authorized, server changes the broker
   === Not implemented yet ===
   brokername : str
       name of the broker to replace
   detector_name : str
       Name of the detector
   admin_pass : str
       Simple password as a string
   firedrill : bool
       Whether to use the firedrill broker



.. py:function:: get_feedback(detector_name=None, email_address=None, firedrill=True)

   Get heartbeat feedback by email
   For a given detector, if your email is registered
   We are going to send that email address(es) an email with feedback from last 24hours.
   multiple email addresses are allowed with a semicolon delimiter (;)

   :param detector_name: Name of your detector
   :type detector_name: str
   :param email_address: Registered e-mail adress(es)
   :type email_address: str or list
   :param firedrill: Whether to use firedrill broker or not
   :type firedrill: bool