diff sat/tools/async_trigger.py @ 2645:f2cf1daa42cb

core: added async TriggerManager Async trigger manager add an asyncPoint method which can be used with Deferred (or sync method). This allow a triggers do to some long operations like doing network requests. MessageReceived and sendMessageData now use asyncPoint.
author Goffi <goffi@goffi.org>
date Sun, 29 Jul 2018 19:22:51 +0200
parents
children 3a8e7ec4648a
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sat/tools/async_trigger.py	Sun Jul 29 19:22:51 2018 +0200
@@ -0,0 +1,46 @@
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+
+# SAT: a jabber client
+# Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Misc usefull classes"""
+
+from sat.tools import trigger as sync_trigger
+from twisted.internet import defer
+
+class TriggerManager(sync_trigger.TriggerManager):
+    """This is a TriggerManager with an new asyncPoint method"""
+
+    @defer.inlineCallbacks
+    def asyncPoint(self, point_name, *args, **kwargs):
+        """This put a trigger point with potentially async Deferred
+
+        All the triggers for that point will be run
+        @param point_name: name of the trigger point
+        @return D(bool): True if the action must be continued, False else
+        """
+        if point_name not in self.__triggers:
+            defer.returnValue(True)
+
+        for priority, trigger in self.__triggers[point_name]:
+            try:
+                cont = yield trigger(*args, **kwargs)
+                if not cont:
+                    defer.returnValue(False)
+            except sync_trigger.SkipOtherTriggers:
+                break
+        defer.returnValue(True)