summary refs log tree commit diff
path: root/docs/server-server/protocol-format.rst
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-08-12 16:05:23 +0100
committerMark Haines <mark.haines@matrix.org>2014-08-12 16:39:35 +0100
commitcf45ed1bc0bb23917001b63adaca7fd126c64996 (patch)
tree79ccb12349f7b8f6ce954bf5373c6282bc898fd9 /docs/server-server/protocol-format.rst
parentReference Matrix Home Server (diff)
downloadsynapse-cf45ed1bc0bb23917001b63adaca7fd126c64996.tar.xz
Add .rst suffix to documentation files so that github auto-formats them
Diffstat (limited to 'docs/server-server/protocol-format.rst')
-rw-r--r--docs/server-server/protocol-format.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/server-server/protocol-format.rst b/docs/server-server/protocol-format.rst
new file mode 100644
index 0000000000..2838253ab7
--- /dev/null
+++ b/docs/server-server/protocol-format.rst
@@ -0,0 +1,59 @@
+
+Transaction
+===========
+
+Required keys:
+
+============ =================== ===============================================
+    Key            Type                         Description
+============ =================== ===============================================
+origin       String              DNS name of homeserver making this transaction.
+ts           Integer             Timestamp in milliseconds on originating 
+                                 homeserver when this transaction started.
+previous_ids List of Strings     List of transactions that were sent immediately
+                                 prior to this transaction.
+pdus         List of Objects     List of updates contained in this transaction.
+============ =================== ===============================================
+
+
+PDU
+===
+
+Required keys:
+
+============ ================== ================================================
+    Key            Type                         Description
+============ ================== ================================================
+context      String             Event context identifier
+origin       String             DNS name of homeserver that created this PDU.
+pdu_id       String             Unique identifier for PDU within the context for
+                                the originating homeserver.
+ts           Integer            Timestamp in milliseconds on originating 
+                                homeserver when this PDU was created.
+pdu_type     String             PDU event type.
+prev_pdus    List of Pairs      The originating homeserver and PDU ids of the
+             of Strings         most recent PDUs the homeserver was aware of for
+                                this context when it made this PDU.
+depth        Integer            The maximum depth of the previous PDUs plus one.
+============ ================== ================================================
+
+Keys for state updates:
+
+================== ============ ================================================
+    Key               Type                      Description
+================== ============ ================================================
+is_state           Boolean      True if this PDU is updating state.
+state_key          String       Optional key identifying the updated state within
+                                the context.
+power_level        Integer      The asserted power level of the user performing
+                                the update.
+min_update         Integer      The required power level needed to replace this
+                                update.
+prev_state_id      String       The homeserver of the update this replaces
+prev_state_origin  String       The PDU id of the update this replaces.
+user               String       The user updating the state.
+================== ============ ================================================
+
+
+
+