From 5ebf4e912e89b1346abcd9e20ecffe56b2a71cc3 Mon Sep 17 00:00:00 2001
From: Fabio Manganiello <fabio@manganiello.tech>
Date: Fri, 24 Mar 2023 16:05:18 +0100
Subject: [PATCH] Added `wait_stop` and `shoud_stop` methods to
 `StoppableThread`.

---
 platypush/common/_types.py | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/platypush/common/_types.py b/platypush/common/_types.py
index b4455e4c20..565cf21e12 100644
--- a/platypush/common/_types.py
+++ b/platypush/common/_types.py
@@ -1,5 +1,6 @@
-from abc import ABC, abstractmethod
-from threading import Thread
+from abc import ABC
+from threading import Event, Thread
+from typing import Optional
 
 
 class StoppableThread(Thread, ABC):
@@ -7,6 +8,29 @@ class StoppableThread(Thread, ABC):
     Base interface for stoppable threads.
     """
 
-    @abstractmethod
+    def __init__(self, *args, stop_event: Optional[Event] = None, **kwargs):
+        """
+        :param stop_event: Event used to signal the thread to stop.
+        """
+        super().__init__(*args, **kwargs)
+        self._stop_event = stop_event or Event()
+
+    def should_stop(self) -> bool:
+        """
+        :return: ``True`` if the thread should be stopped, ``False`` otherwise.
+        """
+        return self._stop_event.is_set()
+
+    def wait_stop(self, timeout: Optional[float] = None):
+        """
+        Wait for the stop event to be set.
+
+        :param timeout: Timeout in seconds (default: no timeout).
+        """
+        self._stop_event.wait(timeout)
+
     def stop(self):
-        ...
+        """
+        Signal the thread to stop by setting the stop event.
+        """
+        self._stop_event.set()