slixmpp/plugins/xep_0323/timerreset.py

   1 """
   2     Slixmpp: The Slick XMPP Library
   3     Implementation of xeps for Internet of Things
   4     http://wiki.xmpp.org/web/Tech_pages/IoT_systems
   5     Copyright (C) 2013 Sustainable Innovation, Joachim.lindborg@sust.se, bjorn.westrom@consoden.se
   6     This file is part of Slixmpp.
   7
   8     See the file LICENSE for copying permission.
   9 """
  10 from threading import Thread, Event, Timer
  11 import time
  12
  13 def TimerReset(*args, **kwargs):
  14     """ Global function for Timer """
  15     return _TimerReset(*args, **kwargs)
  16
  17
  18 class _TimerReset(Thread):
  19     """Call a function after a specified number of seconds:
  20
  21     t = TimerReset(30.0, f, args=[], kwargs={})
  22     t.start()
  23     t.cancel() # stop the timer's action if it's still waiting
  24     """
  25
  26     def __init__(self, interval, function, args=[], kwargs={}):
  27         Thread.__init__(self)
  28         self.interval = interval
  29         self.function = function
  30         self.args = args
  31         self.kwargs = kwargs
  32         self.finished = Event()
  33         self.resetted = True
  34
  35     def cancel(self):
  36         """Stop the timer if it hasn't finished yet"""
  37         self.finished.set()
  38
  39     def run(self):
  40         #print "Time: %s - timer running..." % time.asctime()
  41
  42         while self.resetted:
  43             #print "Time: %s - timer waiting for timeout in %.2f..." % (time.asctime(), self.interval)
  44             self.resetted = False
  45             self.finished.wait(self.interval)
  46
  47         if not self.finished.isSet():
  48             self.function(*self.args, **self.kwargs)
  49         self.finished.set()
  50         #print "Time: %s - timer finished!" % time.asctime()
  51
  52     def reset(self, interval=None):
  53         """ Reset the timer """
  54
  55         if interval:
  56             #print "Time: %s - timer resetting to %.2f..." % (time.asctime(), interval)
  57             self.interval = interval
  58         else:
  59             #print "Time: %s - timer resetting..." % time.asctime()
  60             pass
  61
  62         self.resetted = True
  63         self.finished.set()
  64         self.finished.clear()