From f6455de7d4ca6718bd3dbf851b21ba0b478c979c Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Tue, 12 Oct 2021 15:15:52 +0200
Subject: [PATCH] L2SS-412: Fixed typo, explained explicitly that ping() can
and should throw in case of issues
---
devices/clients/comms_client.py | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/devices/clients/comms_client.py b/devices/clients/comms_client.py
index b3d62645a..ab5279562 100644
--- a/devices/clients/comms_client.py
+++ b/devices/clients/comms_client.py
@@ -13,10 +13,13 @@ class AbstractCommClient(ABC):
@abstractmethod
def stop(self):
- """ Start communication with the client. """
+ """ Stop communication with the client. """
def ping(self):
- """ Check whether the connection is still alive. Raises an exception if not. """
+ """ Check whether the connection is still alive.
+
+ Clients that override this method must raise an Exception if the
+ connection died. """
pass
@abstractmethod
@@ -125,7 +128,11 @@ class CommClient(AbstractCommClient, Thread):
time.sleep(self.try_interval)
def ping(self):
- return
+ """ Check whether the connection is still alive.
+
+ Clients that override this method must raise an Exception if the
+ connection died. """
+ pass
def stop(self):
"""
--
GitLab