diff options
| author | David Robertson <davidr@element.io> | 2022-02-02 15:11:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-02 15:11:23 +0000 |
| commit | f510fba4ba9d0ebf0c062f0a561da19b2ea0c2d6 (patch) | |
| tree | 755e958372e57767cd8acb984884d09039cfa94c /synapse/util/caches/lrucache.py | |
| parent | Revert experimental push rules from #7997. (#11884) (diff) | |
| download | synapse-f510fba4ba9d0ebf0c062f0a561da19b2ea0c2d6.tar.xz | |
Describe `prune_unread_entries` in docstrings (#11876)
Should have been caught in #10826.
Diffstat (limited to 'synapse/util/caches/lrucache.py')
| -rw-r--r-- | synapse/util/caches/lrucache.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/util/caches/lrucache.py b/synapse/util/caches/lrucache.py index 3f11a2f9dd..7548b38548 100644 --- a/synapse/util/caches/lrucache.py +++ b/synapse/util/caches/lrucache.py @@ -340,6 +340,12 @@ class LruCache(Generic[KT, VT]): apply_cache_factor_from_config (bool): If true, `max_size` will be multiplied by a cache factor derived from the homeserver config + + clock: + + prune_unread_entries: If True, cache entries that haven't been read recently + will be evicted from the cache in the background. Set to False to + opt-out of this behaviour. """ # Default `clock` to something sensible. Note that we rename it to # `real_clock` so that mypy doesn't think its still `Optional`. |