[tor-commits] [torspec/master] Document a corner-case of the STREAM event format

[nickm at torproject.org]

commit 3ad9d19e03bd816e1e0f0b9eeb839ee1eedcaedf
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Feb 7 16:46:03 2013 -0500

    Document a corner-case of the STREAM event format
    
    Fix for 7598
---
 control-spec.txt |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index 80e1194..5ea5038 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -1411,10 +1411,15 @@
                "CLOSED"       / ; Stream closed
                "DETACHED"       ; Detached from circuit; still retriable
 
-       Target = Address ":" Port
+       Target = TargetAddress ":" Port
+       Port = an integer from 0 to 65535 inclusive
+       TargetAddress = Address / "(Tor_internal)"
 
   The circuit ID designates which circuit this stream is attached to.  If
-  the stream is unattached, the circuit ID "0" is given.
+  the stream is unattached, the circuit ID "0" is given.  The target
+  indicates the address which the stream is meant to resolve or connect to;
+  it can be "(Tor_internal)" for a virtual stream created by the Tor program
+  to talk to itself.
 
       Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" /
                "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" /