[or-cvs] Revise tor-spec to add more/better stream end reasons.

[Nick Mathewson]

Update of /home/or/cvsroot/tor/doc
In directory moria.mit.edu:/tmp/cvs-serv20155/doc

Modified Files:
	tor-spec.txt 
Log Message:
Revise tor-spec to add more/better stream end reasons.

Index: tor-spec.txt
===================================================================
RCS file: /home/or/cvsroot/tor/doc/tor-spec.txt,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -d -r1.77 -r1.78
--- tor-spec.txt	30 Jan 2005 00:20:15 -0000	1.77
+++ tor-spec.txt	1 Mar 2005 22:07:36 -0000	1.78
@@ -459,16 +459,30 @@
 
        1 -- REASON_MISC           (catch-all for unlisted reasons)
        2 -- REASON_RESOLVEFAILED  (couldn't look up hostname)
-       3 -- REASON_CONNECTFAILED  (couldn't connect to host/port)
+       3 -- REASON_CONNECTREFUSED (remote host refused connection) [*]
        4 -- REASON_EXITPOLICY     (OR refuses to connect to host or port)
-       5 -- REASON_DESTROY        (circuit is being destroyed [???-NM])
-       6 -- REASON_DONE           (anonymized TCP connection was closed)
-       7 -- REASON_TIMEOUT        (OR timed out while connecting [???-NM])
+       5 -- REASON_DESTROY        (Circuit is being destroyed)
+       6 -- REASON_DONE           (Anonymized TCP connection was closed)
+       7 -- REASON_TIMEOUT        (Connection timed out, or OR timed out
+                                   while connecting)
+       8 -- (unallocated) [**]
+       9 -- REASON_HIBERNATING    (OR is temporarily hibernating)
+      10 -- REASON_INTERNAL       (Internal error at the OR)
+      11 -- REASON_RESOURCELIMIT  (OR has no resources to fulfill request)
+      12 -- REASON_CONNRESET      (Connection was unexpectedly reset)
 
    (With REASON_EXITPOLICY, the 4-byte IPv4 address or 16-byte IPv6 address
    forms the optional data; no other reason currently has extra data.)
 
-   *** [The rest of this section describes unimplemented functionality.]
+   OPs and ORs MUST accept reasons not on the above list, since future
+   versions of Tor may provide more fine-grained reasons.
+
+   [*] Older versions of Tor also send this reason when connections are
+       reset.
+   [**] Due to a bug in versions of Tor through 0095, error reason 8 must
+        remain allocated until that version is obsolete.
+
+   --- [The rest of this section describes unimplemented functionality.]
 
    Because TCP connections can be half-open, we follow an equivalent
    to TCP's FIN/FIN-ACK/ACK protocol to close streams.