Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
moved notice to paragraph under stream_writers
Browse files Browse the repository at this point in the history
Signed-off-by: creme <creme@envs.net>
  • Loading branch information
cremesk committed Mar 9, 2022
1 parent 26518ba commit 91a80ec
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
2 changes: 1 addition & 1 deletion changelog.d/12196.doc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Document stream writer `to_device`, `account_data`, `receipts`, and `presence` can only be used on a single worker.
Document stream writer `typing`, `to_device`, `account_data`, `receipts`, and `presence` can only be used on a single worker.
23 changes: 13 additions & 10 deletions docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,9 @@ Some of the streams have associated endpoints which, for maximum efficiency, sho
be routed to the workers handling that stream. See below for the currently supported
streams and the endpoints associated with them:

unless otherwise documented, stream_writers can only be used by a single worker
instance.

##### The `events` stream

The `events` stream also experimentally supports having multiple writers, where
Expand All @@ -384,38 +387,38 @@ stream_writers:

##### The `typing` stream

The following endpoints should be routed directly to a single worker configured
as stream writers for the `typing` stream:
The following endpoints should be routed directly to the worker configured as
stream writers for the `typing` stream:

^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/typing

##### The `to_device` stream

The following endpoints should be routed directly to a single worker configured
as stream writers for the `to_device` stream:
The following endpoints should be routed directly to the worker configured as
stream writers for the `to_device` stream:

^/_matrix/client/(api/v1|r0|v3|unstable)/sendToDevice/

##### The `account_data` stream

The following endpoints should be routed directly to a single worker configured
as stream writers for the `account_data` stream:
The following endpoints should be routed directly to the worker configured as
stream writers for the `account_data` stream:

^/_matrix/client/(api/v1|r0|v3|unstable)/.*/tags
^/_matrix/client/(api/v1|r0|v3|unstable)/.*/account_data

##### The `receipts` stream

The following endpoints should be routed directly to a single worker configured
as stream writers for the `receipts` stream:
The following endpoints should be routed directly to the worker configured as
stream writers for the `receipts` stream:

^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/receipt
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/read_markers

##### The `presence` stream

The following endpoints should be routed directly to a single worker configured
as stream writers for the `presence` stream:
The following endpoints should be routed directly to the worker configured as
stream writers for the `presence` stream:

^/_matrix/client/(api/v1|r0|v3|unstable)/presence/

Expand Down

0 comments on commit 91a80ec

Please sign in to comment.