From a7ca56b537e7723f528da7810561bad3d9cc9fab Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 12 Oct 2005 13:49:13 +0000
Subject: More work towards a sane digest-based liveness testing.

svn:r5238
---
 doc/TODO             | 17 +++++++++++++++--
 doc/control-spec.txt | 19 +++++++++++++++++--
 2 files changed, 32 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/TODO b/doc/TODO
index 37991cfd2d..93f557268c 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -43,9 +43,22 @@ R - are dirservers auto-verifying duplicate nicknames?
 
   o controller libs should support resetconf command.
 N . Additional controller features
-      - Find a way to make event info more extensible
+      o Find a way to make event info more extensible
       - change circuit status events to give more details, like purpose,
-        whether they're internal, etc.
+        whether they're internal, when they become dirty, when they become
+        too dirty for further circuits, etc.
+R       - What do we want here, exactly?
+N       - Specify and implement it.
+      - Change stream status events analogously.
+R       - What do we want here, exactly?
+N       - Specify and implement it.
+      - Make other events "better".
+      - Change stream status events analogously.
+R       - What do we want here, exactly?
+N       - Specify and implement it.
+      - Make other events "better" analogously
+R       - What do we want here, exactly?
+N       - Specify and implement it.
       . Expose more information via getinfo:
         - import and export rendezvous descriptors
         - Review all static fields for additional candidates
diff --git a/doc/control-spec.txt b/doc/control-spec.txt
index 0fd970d991..1666f673b8 100644
--- a/doc/control-spec.txt
+++ b/doc/control-spec.txt
@@ -167,7 +167,7 @@ $Id$
   Request the server to inform the client about interesting events.  The
   syntax is:
 
-     "SETEVENTS" *(SP EventCode) CRLF
+     "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
 
      EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
          "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP"
@@ -179,6 +179,12 @@ $Id$
   Unrecognized event" reply if one of the event codes isn't recognized.  (On
   error, the list of active event codes isn't changed.)
 
+  If the flag string "EXTENDED" is provided, Tor may provide extra
+  information with events for this connection; see 4.1 for more information.
+  NOTE: All events on a given connection will be provided in extended format,
+  or none.
+  NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
+
 3.5. AUTHENTICATE
 
   Sent from the client to the server.  The syntax is:
@@ -579,10 +585,19 @@ $Id$
   expected.  For instance, a client that expects a CIRC message like:
       650 CIRC 1000 EXTENDED moria1,moria2
   should tolerate:
-      650+CIRC 1000 EXTENDED moria1,moria2 0xBEEF
+      650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
       650-EXTRAMAGIC=99
       650 ANONYMITY=high
 
+  If clients ask for extended events, then each event line as specified below
+  will be followed by additional extensions.  Clients that do so MUST
+  tolerate additional arguments and lines.  Additional lines will be of the
+  form
+      "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
+  Additional arguments will be of the form
+      SP KEYWORD ["=" ( QuoutedString / * NonSpDquote ) ]
+  Such clients MUST tolerate lines with keywords they do not recognize.
+
 4.1.1. Circuit status changed
 
    The syntax is:
-- 
cgit v1.2.3-54-g00ecf