summaryrefslogtreecommitdiff
path: root/doc/control-spec.txt
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2006-10-09 15:47:50 +0000
committerNick Mathewson <nickm@torproject.org>2006-10-09 15:47:50 +0000
commit26283e69ba88896d8aeb9141bdaeff15be916ec8 (patch)
tree377a1490710afcdd83ebd6e26559a74a1e0a6e9d /doc/control-spec.txt
parentb76fd968b4d2deddf2f40f63dc04713f45649c68 (diff)
downloadtor-26283e69ba88896d8aeb9141bdaeff15be916ec8.tar.gz
tor-26283e69ba88896d8aeb9141bdaeff15be916ec8.zip
r8973@totoro: nickm | 2006-10-09 11:45:47 -0400
Touch up last patch (to add REASON to CIRC events): make some reasons more sensible, send reasons only to controllers that have enabled extended events, and clean up whitespace. svn:r8672
Diffstat (limited to 'doc/control-spec.txt')
-rw-r--r--doc/control-spec.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/control-spec.txt b/doc/control-spec.txt
index 003f9ef23f..a10774ae64 100644
--- a/doc/control-spec.txt
+++ b/doc/control-spec.txt
@@ -751,7 +751,7 @@ $Id$
The syntax is:
- "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
+ "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
[SP "REASON=" Reason] CRLF
CircStatus =
@@ -763,14 +763,18 @@ $Id$
Path = ServerID *("," ServerID)
- Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
+ Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
"HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
"OR_IDENTITY" / "OR_CONN_CLOSED"
The path is provided only when the circuit has been extended at least one
hop.
- Reason is provided only for FAILED and CLOSED events.
+ The "REASON" field is provided only for FAILED and CLOSED events, and only
+ if extended events are enabled (see 3.19). Clients MUST accept reasons
+ not listed above.
+
+ [XXXX Explain what the reasons mean.]
4.1.2. Stream status changed