[tor-commits] [torspec/master] control: Document missing options to ADD_ONION

[nickm at torproject.org]

commit 2fcb1c2e613ac30fdd42bc2cf0a18c8ee4478d64
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Nov 14 10:03:37 2017 -0500

    control: Document missing options to ADD_ONION
    
    Adds the optional argument "MaxStreams=" and the flag value
    "MaxStreamsCloseCircuit" that are implemented but not specified in the
    control spec.
    
    Closes #24201.
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 control-spec.txt | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index 1925ff8..b556cd4 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -1511,6 +1511,7 @@
   The syntax is:
     "ADD_ONION" SP KeyType ":" KeyBlob
             [SP "Flags=" Flag *("," Flag)]
+            [SP "MaxStreams=" NumStreams]
             1*(SP "Port=" VirtPort ["," Target])
             *(SP "ClientAuth=" ClientName [":" ClientBlob]) CRLF
 
@@ -1533,9 +1534,15 @@
                      to the current control connection.
      "BasicAuth" / ; Client authorization is required using the "basic"
                      method.
-     "NonAnonymous"; Add a non-anonymous Single Onion Service. Tor
-                     checks this flag matches its configured hidden
-                     service anonymity mode.
+     "NonAnonymous" /; Add a non-anonymous Single Onion Service. Tor
+                       checks this flag matches its configured hidden
+                       service anonymity mode.
+     "MaxStreamsCloseCircuit"; Close the circuit is the maximum streams
+                               allowed is reached.
+
+    NumStreams = A value between 0 and 65535 which is used as the maximum
+                 streams that can be attached on a rendezvous circuit. Setting
+                 it to 0 means unlimited which is also the default behavior.
 
     VirtPort = The virtual TCP Port for the Onion Service (As in the
                HiddenServicePort "VIRTPORT" argument).