OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

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

pull/12683/head
Shay 2022-05-09 14:46:43 -07:00 committed by GitHub
parent 615d96ad6e
commit d80a7ab151
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/12621.doc Normal file
View File

@ -0,0 +1 @@
Add information about the TCP replication module to docs.

5
docs/replication.md
View File

@ -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
synapse/replication/tcp/__init__.py
View File

@ -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: