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

Add documentation for missing worker types. #11599

Merged
merged 22 commits into from
Feb 23, 2022
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add documentation for missing worker types.
clokep committed Dec 17, 2021
commit b84f9d89e7b0d5e2fa1cd42e9cb36465aedf45b5
28 changes: 26 additions & 2 deletions docs/workers.md
Original file line number Diff line number Diff line change
@@ -238,19 +238,37 @@ expressions:
^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms$
^/_matrix/client/(api/v1|r0|v3|unstable)/search$

# Encryption requests
^/_matrix/client/(api/v1|r0|v3|unstable)/keys/claim
^/_matrix/client/(api/v1|r0|v3|unstable)/room_keys

# Registration/login requests
^/_matrix/client/(api/v1|r0|v3|unstable)/login$
^/_matrix/client/(r0|v3|unstable)/register$
^/_matrix/client/unstable/org.matrix.msc3231/register/org.matrix.msc3231.login.registration_token/validity$

# Event sending requests
# Event sending requests (for the event stream writer)
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/redact
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/send
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state/
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$
^/_matrix/client/(api/v1|r0|v3|unstable)/join/
^/_matrix/client/(api/v1|r0|v3|unstable)/profile/

# Typing requests (for the typing stream writer)
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/typing

# Device requests (for the to_device stream writer)
^/_matrix/client/(api/v1|r0|v3|unstable)/sendToDevice/

# Account data requests (for the account_data stream writer)
^/_matrix/client/(api/v1|r0|v3|unstable)/.*/tags
^/_matrix/client/(api/v1|r0|v3|unstable)/.*/account_data

# Receipts requests (for the receipts stream writer)
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/receipt
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/read_markers


Additionally, the following REST endpoints can be handled for GET requests:

@@ -330,7 +348,13 @@ Additionally, there is *experimental* support for moving writing of specific
streams (such as events) off of the main process to a particular worker. (This
is only supported with Redis-based replication.)

Currently supported streams are `events` and `typing`.
Currently supported streams are:

* `events`
* `typing`
* `to_device`
* `account_data`
* `receipts`

To enable this, the worker must have a HTTP replication listener configured,
have a `worker_name` and be listed in the `instance_map` config. For example to