diff options
| author | Erik Johnston <erik@matrix.org> | 2017-03-31 11:19:24 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2017-03-31 11:19:24 +0100 |
| commit | bfcf016714575edb0ad2c19b2f00694d62ca08ec (patch) | |
| tree | 7138a029e500839ec5dfc15c361427a2f42cf3fe /docs/tcp_replication.rst | |
| parent | Remove user from process_presence when stops syncing (diff) | |
| download | synapse-bfcf016714575edb0ad2c19b2f00694d62ca08ec.tar.xz | |
Fix up docs
Diffstat (limited to '')
| -rw-r--r-- | docs/tcp_replication.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/tcp_replication.rst b/docs/tcp_replication.rst index be0aa6b28c..7393527f6f 100644 --- a/docs/tcp_replication.rst +++ b/docs/tcp_replication.rst @@ -1,20 +1,20 @@ TCP Replication =============== -This describes the TCP replication protocol that replaces the HTTP protocol. - Motivation ---------- -The HTTP API used long poll from the workers to the master, this has the problem -of causing a lot of duplicate work on the server. This TCP protocol aims to -solve. +Previously the workers used an HTTP long poll mechanism to get updates from the +master, which had the problem of causing a lot of duplicate work on the server. +This TCP protocol replaces those APIs with the aim of increased efficiency. + + Overview -------- The protocol is based on fire and forget, line based commands. An example flow -would be (where '>' indicates master->worker and '<' worker->master flows):: +would be (where '>' indicates master to worker and '<' worker to master flows):: > SERVER example.com < REPLICATE events 53 @@ -24,7 +24,7 @@ would be (where '>' indicates master->worker and '<' worker->master flows):: The example shows the server accepting a new connection and sending its identity with the ``SERVER`` command, followed by the client asking to subscribe to the ``events`` stream from the token ``53``. The server then periodically sends ``RDATA`` -commands which have the format ``RDATA <stream_name> <token> <row>```, where the +commands which have the format ``RDATA <stream_name> <token> <row>``, where the format of ``<row>`` is defined by the individual streams. Error reporting happens by either the client or server sending an `ERROR` @@ -125,7 +125,7 @@ recovers it can reconnect to the server and ask for missed messages. Reliability ~~~~~~~~~~~ -In general the replication stream should be consisdered an unreliable transport +In general the replication stream should be considered an unreliable transport since e.g. commands are not resent if the connection disappears. The exception to that are the replication streams, i.e. RDATA commands, since |