summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2019-07-29 10:03:14 +0200
committerBrendan Abolivier <babolivier@matrix.org>2019-07-29 10:03:14 +0200
commit244953be3f2532fbb57f5ecd09ed499bcb1e1c69 (patch)
treedf60318bf130c9dcee56ec125d7a4e3140dd834c /synapse
parentAdd ability to pass arguments to looping calls (diff)
downloadsynapse-244953be3f2532fbb57f5ecd09ed499bcb1e1c69.tar.xz
Add kwargs and doc
Diffstat (limited to 'synapse')
-rw-r--r--synapse/util/__init__.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/synapse/util/__init__.py b/synapse/util/__init__.py
index 9e0a47d206..7856353002 100644
--- a/synapse/util/__init__.py
+++ b/synapse/util/__init__.py
@@ -59,7 +59,7 @@ class Clock(object):
         """Returns the current system time in miliseconds since epoch."""
         return int(self.time() * 1000)
 
-    def looping_call(self, f, msec, *args):
+    def looping_call(self, f, msec, *args, **kwargs):
         """Call a function repeatedly.
 
         Waits `msec` initially before calling `f` for the first time.
@@ -70,8 +70,10 @@ class Clock(object):
         Args:
             f(function): The function to call repeatedly.
             msec(float): How long to wait between calls in milliseconds.
+            *args: Postional arguments to pass to function.
+            **kwargs: Key arguments to pass to function.
         """
-        call = task.LoopingCall(f, *args)
+        call = task.LoopingCall(f, *args, **kwargs)
         call.clock = self._reactor
         d = call.start(msec / 1000.0, now=False)
         d.addErrback(log_failure, "Looping call died", consumeErrors=False)