comparison 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
comparison
equal deleted inserted replaced
2644:e107089d6640 2645:f2cf1daa42cb
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT: a jabber client
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 """Misc usefull classes"""
21
22 from sat.tools import trigger as sync_trigger
23 from twisted.internet import defer
24
25 class TriggerManager(sync_trigger.TriggerManager):
26 """This is a TriggerManager with an new asyncPoint method"""
27
28 @defer.inlineCallbacks
29 def asyncPoint(self, point_name, *args, **kwargs):
30 """This put a trigger point with potentially async Deferred
31
32 All the triggers for that point will be run
33 @param point_name: name of the trigger point
34 @return D(bool): True if the action must be continued, False else
35 """
36 if point_name not in self.__triggers:
37 defer.returnValue(True)
38
39 for priority, trigger in self.__triggers[point_name]:
40 try:
41 cont = yield trigger(*args, **kwargs)
42 if not cont:
43 defer.returnValue(False)
44 except sync_trigger.SkipOtherTriggers:
45 break
46 defer.returnValue(True)