[or-cvs] Implement some more GETINFO goodness: expose helper nodes, ...

[Nick Mathewson]

Update of /home/or/cvsroot/tor/doc
In directory moria:/tmp/cvs-serv31376/doc

Modified Files:
	TODO control-spec.txt 
Log Message:
Implement some more GETINFO goodness: expose helper nodes, config options, getinfo keys.

Index: TODO
===================================================================
RCS file: /home/or/cvsroot/tor/doc/TODO,v
retrieving revision 1.336
retrieving revision 1.337
diff -u -d -r1.336 -r1.337
--- TODO	4 Aug 2005 18:23:21 -0000	1.336
+++ TODO	4 Aug 2005 19:56:41 -0000	1.337
@@ -78,12 +78,16 @@
         o Implement main controller interface
         o Glue code
         o Testing
-N - Additional controller features
-      - Expose more information via getinfo
+N . Additional controller features
+      . Expose more information via getinfo:
         o Accounting status
-        - Helper node status
-        - Review all static fields for candidates
-        - List of available getinfo/getconf fields.
+        o Helper node status
+          o Document
+          o Implement
+        o List of available getinfo/getconf fields.
+          o Document
+          o Implement
+        - Review all static fields for additional candidates
       - Allow EXTENDCIRCUIT to unknown server.
       - We need some way to adjust server status, and to tell tor not to
         download directories/network-status, and a way to force a download.

Index: control-spec.txt
===================================================================
RCS file: /home/or/cvsroot/tor/doc/control-spec.txt,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -d -r1.47 -r1.48
--- control-spec.txt	17 Jul 2005 22:39:21 -0000	1.47
+++ control-spec.txt	4 Aug 2005 19:56:41 -0000	1.48
@@ -325,6 +325,45 @@
       form:
          ServerID SP ORStatus CRLF
 
+    "helper-nodes"
+      A series of lines listing the currently chosen helper nodes, if any.
+      Each is of the form:
+         ServerID  SP ((("down" / "unlisted") ISOTime) / "up")  CRLF
+
+    "accounting/enabled"
+    "accounting/hibernating"
+    "accounting/bytes"
+    "accounting/bytes-left"
+    "accounting/interval-start"
+    "accounting/interval-wake"
+    "accounting/interval-end"
+      Information about accounting status.  If accounting is enabled,
+      "enabled" is 1; otherwise it is 0.  The "hibernating" field is "hard"
+      if we are accepting no data; "soft" if we're accepting no new
+      connections, and "awake" if we're not hibernating at all.  The "bytes"
+      and "bytes-left" fields contain (read-bytes SP write-bytes), for the
+      start and the rest of the interval respectively.  The 'interval-start'
+      and 'interval-end' fields are the borders of the current interval; the
+      'interval-wake' field is the time within the current interval (if any)
+      where we plan[ned] to start being active.
+
+    "config/names"
+      A series of lines listing the available configuration options. Each is
+      of the form:
+         OptionName SP OptionType [ SP Documentation ] CRLF
+         OptionName = Keyword
+         OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
+           "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
+           "String" / "LineList"
+         Documentation = Text
+
+    "info/names"
+      A series of lines listing the available GETINFO options.  Each is of
+      one of thes forms:
+         OptionName SP Documentation CRLF
+         OptionPrefix SP Documentation CRLF
+         OptionPrefix = OptionName "/*"
+
   Examples:
      C: GETINFO version desc/name/moria1
      S: 250+desc/name/moria=