AaronFiore/electrum
1
0
Fork 0
Code Activity

util: document CallbackManager behaviour

Browse Source
This commit is contained in:
SomberNight
2021-03-11 18:50:59 +01:00
parent 533d796a41
commit 28a7d204ad
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
electrum/util.py
View File

@@ -1380,7 +1380,9 @@ def randrange(bound: int) -> int:
class CallbackManager: class CallbackManager:
# callbacks set by the GUI # callbacks set by the GUI or any thread
# guarantee: the callbacks will always get triggered from the asyncio thread.
def __init__(self): def __init__(self):
self.callback_lock = threading.Lock() self.callback_lock = threading.Lock()
self.callbacks = defaultdict(list) # note: needs self.callback_lock self.callbacks = defaultdict(list) # note: needs self.callback_lock
@@ -1398,6 +1400,10 @@ class CallbackManager:
callbacks.remove(callback) callbacks.remove(callback)
def trigger_callback(self, event, *args): def trigger_callback(self, event, *args):
"""Trigger a callback with given arguments.
Can be called from any thread. The callback itself will get scheduled
on the event loop.
"""
if self.asyncio_loop is None: if self.asyncio_loop is None:
self.asyncio_loop = asyncio.get_event_loop() self.asyncio_loop = asyncio.get_event_loop()
assert self.asyncio_loop.is_running(), "event loop not running" assert self.asyncio_loop.is_running(), "event loop not running"