summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2017-03-31 11:34:40 +0100
committerErik Johnston <erik@matrix.org>2017-03-31 11:34:45 +0100
commitb4276a3896b7fec702feac4a60391ec81e595322 (patch)
treeb48fabbd24c4806ce775172473d132e91833d19b
parentFix up docs (diff)
downloadsynapse-b4276a3896b7fec702feac4a60391ec81e595322.tar.xz
Add a brief list of commands to docs
-rw-r--r--docs/tcp_replication.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/tcp_replication.rst b/docs/tcp_replication.rst
index 7393527f6f..62225ba6f4 100644
--- a/docs/tcp_replication.rst
+++ b/docs/tcp_replication.rst
@@ -175,3 +175,49 @@ An example of a batched set of ``RDATA`` is::
 
 In this case the client shouldn't advance their caches token until it sees the
 the last ``RDATA``.
+
+
+List of commands
+~~~~~~~~~~~~~~~~
+
+The list of valid commands, with which side can send it: server (S) or client (C):
+
+SERVER (S)
+    Sent at the start to identify which server the client is talking to
+
+RDATA (S)
+    A single update in a stream
+
+POSITION (S)
+    The position of the stream has been updated
+
+ERROR (S, C)
+    There was an error
+
+PING (S, C)
+    Sent periodically to ensure the connection is still alive
+
+NAME (C)
+    Sent at the start by client to inform the server who they are
+
+REPLICATE (C)
+    Asks the server to replicate a given stream
+
+USER_SYNC (C)
+    A user has started or stopped syncing
+
+FEDERATION_ACK (C)
+    Acknowledge receipt of some federation data
+
+REMOVE_PUSHER (C)
+    Inform the server a pusher should be removed
+
+INVALIDATE_CACHE (C)
+    Inform the server a cache should be invalidated
+
+SYNC (S, C)
+    Used exclusively in tests
+
+
+See ``synapse/replication/tcp/commands.py`` for a detailed description and the
+format of each command.