diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2023-09-05 12:11:05 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-05 12:11:05 -0400 |
| commit | a2b8814d64714e00acee662d81206944a9a6a56d (patch) | |
| tree | 7570194b65df48fd7378191138354e5604d4a868 | |
| parent | Amend changelog for MSC4041 (diff) | |
| download | synapse-a2b8814d64714e00acee662d81206944a9a6a56d.tar.xz | |
Fix incorrect docstring for Ratelimiter. (#16255)
| -rw-r--r-- | changelog.d/16255.misc | 1 | ||||
| -rw-r--r-- | synapse/api/ratelimiting.py | 7 |
2 files changed, 5 insertions, 3 deletions
diff --git a/changelog.d/16255.misc b/changelog.d/16255.misc new file mode 100644 index 0000000000..94d6aff1d6 --- /dev/null +++ b/changelog.d/16255.misc @@ -0,0 +1 @@ +Fix incorrect docstring for `Ratelimiter`. diff --git a/synapse/api/ratelimiting.py b/synapse/api/ratelimiting.py index 887b214d64..02ae45e8b3 100644 --- a/synapse/api/ratelimiting.py +++ b/synapse/api/ratelimiting.py @@ -40,7 +40,7 @@ class Ratelimiter: - the cost C of this request in tokens. Then, if there is room in the bucket for C tokens (T + C <= `burst_count`), the request is permitted and `cost` tokens are added to the bucket. - Otherwise the request is denied, and the bucket continues to hold T tokens. + Otherwise, the request is denied, and the bucket continues to hold T tokens. This means that the limiter enforces an average request frequency of `rate_hz`, while accumulating a buffer of up to `burst_count` requests which can be consumed @@ -55,9 +55,10 @@ class Ratelimiter: request. Args: + store: The datastore providing get_ratelimit_for_user. clock: A homeserver clock, for retrieving the current time - rate_hz: The long term number of actions that can be performed in a second. - burst_count: How many actions that can be performed before being limited. + cfg: The ratelimit configuration for this rate limiter including the + allowed rate and burst count. """ def __init__( |