wip config reorg

[hippotat.git] / PROTOCOL

diff --git a/PROTOCOL b/PROTOCOL
index c7033af0b2353000b1972b0dcacc8151e12e9ba6..c1ef03b0cfd8cb54a1e335afd2567e153d96ddf7 100644 (file)
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -1,41 +1,20 @@
 Server maintains a queue of outbound packets for each user
 
-Packets which are older than MAX_QUEUE_TIME are discarded
+Packets which are older than the applicable max_queue_time are discarded
 
-Each incoming request to the server takes up to MAX_BATCH_DOWN bytes
+Each incoming request to the server takes up to max_batch_down bytes
 from the queue and returns them as the POST response body payload
 
-Each incoming request contains up to MAX_BATCH_UP bytes of payload.
+Each incoming request contains up to max_batch_up bytes of payload.
 It's a multipart/form-data.
 
 Authentication: for now, plaintext password
 
-Sever side configuration:
-
- [<client-ipaddr>] or [default]
- max_batch_down
- max_queue_time
- max_request_time
- password
-
- [global]
- max_batch_down
- max_queue_time
- max_request_time
-
- [virtual]
- network           # required
- host              # default is first host in network (eg <network>.1)
- relay             # default is first host in network not equal to server
- mtu                # default is 1500
-
-Client side configuration;
- MAX_BATCH_DOWN MAX_QUEUE_TIME PASSWORD
-
 Routing assistance: none needed; secnet polypath will DTRT
 
-Client form parameters:
- i             ip address (textual)
- p             password
+Client form parameters (multipart/form-data):
+ m             metadata, newline-separated list (text file) of
+                       client ip address (textual)
+                       password
+                       target_requests_outstanding
  d              data (SLIP format)
- mbd mqt mrt   config updates