diff options
| author | reivilibre <oliverw@matrix.org> | 2022-03-11 14:00:15 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-11 14:00:15 +0000 |
| commit | 4a53f357379c2dc407617a3d39e6da4790dec9aa (patch) | |
| tree | e73c980ce59d8c8735d36a55faf192488951fc31 /synapse/replication/tcp/streams | |
| parent | Add an additional HTTP pusher + push rule tests. (#12188) (diff) | |
| download | synapse-4a53f357379c2dc407617a3d39e6da4790dec9aa.tar.xz | |
Improve code documentation for the typing stream over replication. (#12211)
Diffstat (limited to 'synapse/replication/tcp/streams')
| -rw-r--r-- | synapse/replication/tcp/streams/_base.py | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/synapse/replication/tcp/streams/_base.py b/synapse/replication/tcp/streams/_base.py index 23d631a769..495f2f0285 100644 --- a/synapse/replication/tcp/streams/_base.py +++ b/synapse/replication/tcp/streams/_base.py @@ -316,7 +316,19 @@ class PresenceFederationStream(Stream): class TypingStream(Stream): @attr.s(slots=True, frozen=True, auto_attribs=True) class TypingStreamRow: + """ + An entry in the typing stream. + Describes all the users that are 'typing' right now in one room. + + When a user stops typing, it will be streamed as a new update with that + user absent; you can think of the `user_ids` list as overwriting the + entire list that was there previously. + """ + + # The room that this update is for. room_id: str + + # All the users that are 'typing' right now in the specified room. user_ids: List[str] NAME = "typing" |