aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-07-27 21:37:45 +0200
committerMattias Andrée <maandree@operamail.com>2014-07-27 21:37:45 +0200
commit229d3eca228d3dd47a004f15aede246c3eb76f56 (patch)
treed863ff5c66bd1fcb9598ebfad5fb03d77511dc35
parentcall server_initialised in mds-echo (diff)
downloadmds-229d3eca228d3dd47a004f15aede246c3eb76f56.tar.gz
mds-229d3eca228d3dd47a004f15aede246c3eb76f56.tar.bz2
mds-229d3eca228d3dd47a004f15aede246c3eb76f56.tar.xz
typo + list currently implemented protocols
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--doc/messages2
-rw-r--r--doc/protocols66
2 files changed, 67 insertions, 1 deletions
diff --git a/doc/messages b/doc/messages
index 314d17a..11409c4 100644
--- a/doc/messages
+++ b/doc/messages
@@ -62,7 +62,7 @@ if it could be used for spying. To tell the server
that you want to intercept a type of message the client
sends a message with the header and value
‘Command: intercept’. It can also specify a priority
-that is an signed 64-bit integer, the default value is
+that is a signed 64-bit integer, the default value is
zero. This is done by using the header ‘Priority’. A
higher priority means that the message is sent earlier.
If the client wishes to be able to modify the message
diff --git a/doc/protocols b/doc/protocols
new file mode 100644
index 0000000..4926b71
--- /dev/null
+++ b/doc/protocols
@@ -0,0 +1,66 @@
+---------------------------------------------------------------------
+
+Command: assign-id
+ Assign new ID to client, or fetch current ID
+
+Purpose: assigning ID to clients so server can respond to that client
+
+Compulsivity: manditory (core infrastructure)
+
+More documentation: doc/messages
+
+Reference implementation: mds-server
+
+---------------------------------------------------------------------
+
+Command: intercept
+ Sign up for reception of message
+
+Optional header: Stop
+ Stop reception of messages if `yes`
+
+Optional header: Priority
+ Signed 64-bit integer of reception priority (reversed of order)
+
+Optional header: Modifying
+ Send message asynchronously and await modification if `yes`
+
+Optional header: Length
+ Length of the message
+
+Message: list of headers and header–value-pairs that qualifies
+ a message for reception, all messages qualifies if this
+ list is empty
+
+Purpose: filter received message for clients and servers
+Purpose: assigned interception order for modification of messages
+
+Compulsivity: manditory (core infrastructure)
+
+More documentation: doc/messages
+
+Reference implementation: mds-server
+
+---------------------------------------------------------------------
+
+Command: echo
+ Echo back a message
+
+Required header: Client ID
+ Your ID, provided by `ID assignment`
+ in response to `Command: assign-id`
+
+Optional header: Length
+ Length of the message
+
+Message: message to echo
+
+Purpose: debugging and testing
+Purpose: network heartbeat
+
+Compulsivity: recommended for network enabled servers
+
+Reference implementation: mds-echo
+
+---------------------------------------------------------------------
+