[or-cvs] r8728: take some more notes on status events we want (tor/trunk/doc)

[arma@xxxxxxxx]

Author: arma
Date: 2006-10-15 03:52:58 -0400 (Sun, 15 Oct 2006)
New Revision: 8728

Modified:
   tor/trunk/doc/control-spec.txt
Log:
take some more notes on status events we want


Modified: tor/trunk/doc/control-spec.txt
===================================================================
--- tor/trunk/doc/control-spec.txt	2006-10-15 07:42:51 UTC (rev 8727)
+++ tor/trunk/doc/control-spec.txt	2006-10-15 07:52:58 UTC (rev 8728)
@@ -193,7 +193,8 @@
 
      EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
          "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
-         "AUTHDIR_NEWDESCS" / "DESCCHANGED"
+         "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
+         "STATUS_CLIENT" / "STATUS_SERVER"
 
   Any events *not* listed in the SETEVENTS line are turned off; thus, sending
   SETEVENTS with an empty body turns off all event reporting.
@@ -370,7 +371,7 @@
       have no guess, return a 551 error. (Added in 0.1.2.2-alpha)
 
     "fingerprint" -- the contents of the fingerprint file that Tor
-      writes as a server; or a 551 if we're not a server currently.
+      writes as a server, or a 551 if we're not a server currently.
       (Added in 0.1.2.3-alpha)
 
     "circuit-status"
@@ -397,7 +398,7 @@
 
       [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
        Tor still supports calling it that for now, but support will be
-       removed in the future.]
+       removed in 0.1.3.x.]
 
     "accounting/enabled"
     "accounting/hibernating"
@@ -907,7 +908,14 @@
        the controller can explain this to the user and encourage her to
        file a bug report?
 
+     // unexpected dir response. behind a hotel/airport firewall?
 
+     // bad http or https proxy?
+
+     // clock is skewed
+     // (either from talking to a dir authority, or from perusing a
+     //  network-status timestamp)
+
   Actions for STATUS_CLIENT events can be as follows:
 
      CIRCUIT_ESTABLISHED
@@ -931,14 +939,28 @@
        down or otherwise not working, and might help to explain for the
        user why Tor appears to be broken.
 
+     GUARD_NODES_CHANGED
 
+     BAD_HOSTNAME
 
+     // a nickname we asked for is unavailable. no need for this
+     // quite yet, since no end-user controllers let you configure that.
+
   Actions for STATUS_SERVER events can be as follows:
 
      EXTERNAL_ADDRESS
      "address=IP"
      "method=guessed/resolved/..."
 
+     // something about failing to parse our address?
+     // from resolve_my_address() in config.c
+
+     // hibernating
+
+     // sketchy libevent, sketchy OS, sketchy threading
+
+     // too many onions queued. threading problem or slow cpu?
+
      CHECKING_REACHABILITY
      "oraddress=IP:port"
      "diraddress=IP:port"
@@ -948,13 +970,14 @@
      "oraddress=IP:port"
      "diraddress=IP:port"
 
+     // dir authorities didn't like my descriptor
 
+     // eventdns statements. like, hijacked dns.
 
 
+  Controllers must tolerate hearing about actions that they don't
+  recognize.
 
-  Controllers must tolerate hearing about status types and actions
-  that they don't recognize.
-
 5. Implementation notes
 
 5.1. Authentication