diff options
author | Erik Johnston <erik@matrix.org> | 2021-08-18 17:02:47 +0100 |
---|---|---|
committer | Erik Johnston <erik@matrix.org> | 2021-08-18 17:02:47 +0100 |
commit | 78a70a2e0bdff5bdf02ba093eefab0b16ebefd73 (patch) | |
tree | 8de7b7805a9840101b00529a50812d6ffcb99cc4 /synapse/module_api | |
parent | Fix weakref_slot parameter for room member storage attrs. (#10642) (diff) | |
parent | Update docs/upgrade.md with new version (diff) | |
download | synapse-78a70a2e0bdff5bdf02ba093eefab0b16ebefd73.tar.xz |
Merge branch 'release-v1.41' into develop
Diffstat (limited to 'synapse/module_api')
-rw-r--r-- | synapse/module_api/__init__.py | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py index 84bb7264a4..b11fa6393b 100644 --- a/synapse/module_api/__init__.py +++ b/synapse/module_api/__init__.py @@ -95,6 +95,7 @@ class ModuleApi: self._state = hs.get_state_handler() self._clock: Clock = hs.get_clock() self._send_email_handler = hs.get_send_email_handler() + self.custom_template_dir = hs.config.server.custom_template_directory try: app_name = self._hs.config.email_app_name @@ -613,10 +614,15 @@ class ModuleApi: msec: float, *args, desc: Optional[str] = None, + run_on_all_instances: bool = False, **kwargs, ): """Wraps a function as a background process and calls it repeatedly. + NOTE: Will only run on the instance that is configured to run + background processes (which is the main process by default), unless + `run_on_all_workers` is set. + Waits `msec` initially before calling `f` for the first time. Args: @@ -627,12 +633,14 @@ class ModuleApi: msec: How long to wait between calls in milliseconds. *args: Positional arguments to pass to function. desc: The background task's description. Default to the function's name. + run_on_all_instances: Whether to run this on all instances, rather + than just the instance configured to run background tasks. **kwargs: Key arguments to pass to function. """ if desc is None: desc = f.__name__ - if self._hs.config.run_background_tasks: + if self._hs.config.run_background_tasks or run_on_all_instances: self._clock.looping_call( run_as_background_process, msec, @@ -689,7 +697,7 @@ class ModuleApi: """ return self._hs.config.read_templates( filenames, - (td for td in (custom_template_directory,) if td), + (td for td in (self.custom_template_dir, custom_template_directory) if td), ) |