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

Update replication.md with info on TCP module structure #12621

Merged
merged 4 commits into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions changelog.d/12621.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add information about the TCP replication module to docs.
5 changes: 5 additions & 0 deletions docs/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,8 @@ See [the TCP replication documentation](tcp_replication.md).
There are read-only version of the synapse storage layer in
`synapse/replication/slave/storage` that use the response of the
replication API to invalidate their caches.

### The TCP Replication Module
Information about how the tcp replication module is structured, including how
the classes interact, can be found in
`synapse/replication/tcp/__init__.py`
2 changes: 1 addition & 1 deletion synapse/replication/tcp/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"""This module implements the TCP replication protocol used by synapse to
communicate between the master process and its workers (when they're enabled).

Further details can be found in docs/tcp_replication.rst
Further details can be found in docs/tcp_replication.md


Structure of the module:
Expand Down