Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Allow modules to check whether the current worker is configured to run background tasks. (#15991)

This commit is contained in:
reivilibre 2023-08-03 12:42:19 +00:00 committed by GitHub
parent 4f5bccbbba
commit 9c462f18a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/15991.misc Normal file
View File

@ -0,0 +1 @@
Allow modules to check whether the current worker is configured to run background tasks.

12
synapse/module_api/__init__.py
View File

@ -1230,6 +1230,18 @@ class ModuleApi:
f, f,
) )
def should_run_background_tasks(self) -> bool:
"""
Return true if and only if the current worker is configured to run
background tasks.
There should only be one worker configured to run background tasks, so
this is helpful when you need to only run a task on one worker but don't
have any other good way to choose which one.
Added in Synapse v1.89.0.
"""
return self._hs.config.worker.run_background_tasks
async def sleep(self, seconds: float) -> None: async def sleep(self, seconds: float) -> None:
"""Sleeps for the given number of seconds. """Sleeps for the given number of seconds.