diff options
Diffstat (limited to 'spec/control-spec/replies.md')
| -rw-r--r-- | spec/control-spec/replies.md | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/spec/control-spec/replies.md b/spec/control-spec/replies.md index 5fb71e7..c55635c 100644 --- a/spec/control-spec/replies.md +++ b/spec/control-spec/replies.md @@ -1,4 +1,5 @@ <a id="control-spec.txt-4"></a> + # Replies Reply codes follow the same 3-character format as used by SMTP, with the @@ -74,6 +75,7 @@ Unless specified to have specific contents, the human-readable messages in error replies should not be relied upon to match those in this document. <a id="control-spec.txt-4.1"></a> + ## Asynchronous events These replies can be sent after a corresponding SETEVENTS command has been @@ -138,6 +140,7 @@ controllers have been fixed. At some point this "SHOULD NOT" might become a "MUST NOT". <a id="control-spec.txt-4.1.1"></a> + ### Circuit status changed The syntax is: @@ -297,6 +300,7 @@ The syntax is: ``` <a id="control-spec.txt-4.1.2"></a> + ### Stream status changed The syntax is: @@ -452,6 +456,7 @@ to talk to itself. ``` <a id="control-spec.txt-4.1.3"></a> + ### OR Connection status changed The syntax is: @@ -524,6 +529,7 @@ events. ``` <a id="control-spec.txt-4.1.4"></a> + ### Bandwidth used in the last second The syntax is: @@ -541,6 +547,7 @@ we may also include a breakdown of the connection types that used bandwidth this second (not implemented yet).] <a id="control-spec.txt-4.1.5"></a> + ### Log messages The syntax is: @@ -562,6 +569,7 @@ Control port message trace debug logs are never sent as control port log events, to avoid modifying control output when debugging. <a id="control-spec.txt-4.1.6"></a> + ### New descriptors available This event is generated when new router descriptors (not microdescs or @@ -578,6 +586,7 @@ Syntax: ``` <a id="control-spec.txt-4.1.7"></a> + ### New Address mapping These events are generated when a new address mapping is entered in @@ -620,6 +629,7 @@ StreamId is the global stream identifier of the stream or circuit from which the address was resolved. <a id="control-spec.txt-4.1.8"></a> + ### Descriptors uploaded to us in our role as authoritative dirserver [NOTE: This feature was removed in Tor 0.3.2.1-alpha.] @@ -645,6 +655,7 @@ complaining. The Message field is a human-readable string explaining why we chose the Action. (It doesn't contain newlines.) <a id="control-spec.txt-4.1.9"></a> + ### Our descriptor changed Syntax: @@ -654,6 +665,7 @@ Syntax: [First added in 0.1.2.2-alpha.] <a id="control-spec.txt-4.1.10"></a> + ### Status events Status events (STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER) are sent @@ -1098,6 +1110,7 @@ Actions for STATUS_GENERAL events can be as follows: ``` <a id="control-spec.txt-4.1.11"></a> + ### Our set of guard nodes has changed Syntax: @@ -1133,6 +1146,7 @@ The Status values are: ``` <a id="control-spec.txt-4.1.12"></a> + ### Network status has changed Syntax: @@ -1148,6 +1162,7 @@ down in our local status, for example based on connection attempts. [First added in 0.1.2.3-alpha] <a id="control-spec.txt-4.1.13"></a> + ### Bandwidth used on an application stream The syntax is: @@ -1176,6 +1191,7 @@ apply only to streams entering Tor (such as on a SOCKSPort, TransPort, or so on). They are not generated for exiting streams. <a id="control-spec.txt-4.1.14"></a> + ### Per-country client stats The syntax is: @@ -1212,6 +1228,7 @@ algorithm is specified in the description of "geoip-client-origins" in dir-spec.txt. <a id="control-spec.txt-4.1.15"></a> + ### New consensus networkstatus has arrived The syntax is: @@ -1229,6 +1246,7 @@ relay *not* mentioned in this list is implicitly no longer recommended. [First added in 0.2.1.13-alpha] <a id="control-spec.txt-4.1.16"></a> + ### New circuit buildtime has been set The syntax is: @@ -1270,6 +1288,7 @@ this value to the nearest second before using it. [First added in 0.2.2.7-alpha] <a id="control-spec.txt-4.1.17"></a> + ### Signal received The syntax is: @@ -1293,6 +1312,7 @@ generate any event. [First added in 0.2.3.1-alpha] <a id="control-spec.txt-4.1.18"></a> + ### Configuration changed The syntax is: @@ -1310,6 +1330,7 @@ signal). KEYWORD and VALUE specify the configuration option that was changed. Undefined configuration options contain only the KEYWORD. <a id="control-spec.txt-4.1.19"></a> + ### Circuit status changed slightly The syntax is: @@ -1338,6 +1359,7 @@ Other fields are as specified in section 4.1.1 above. [First added in 0.2.3.11-alpha] <a id="control-spec.txt-4.1.20"></a> + ### Pluggable transport launched The syntax is: @@ -1355,6 +1377,7 @@ The syntax is: ``` <a id="control-spec.txt-4.1.21"></a> + ### Bandwidth used on an OR or DIR or EXIT connection The syntax is: @@ -1387,6 +1410,7 @@ These events are only generated if TestingTorNetwork is set. [First added in 0.2.5.2-alpha] <a id="control-spec.txt-4.1.22"></a> + ### Bandwidth used by all streams attached to a circuit The syntax is: @@ -1461,6 +1485,7 @@ were added in Tor 0.3.4.0-alpha] [SS, CWND, RTT, and MIN_RTT were added in Tor 0.4.7.5-alpha] <a id="control-spec.txt-4.1.23"></a> + ### Per-circuit cell stats The syntax is: @@ -1532,6 +1557,7 @@ cell. These events are only generated if TestingTorNetwork is set. [First added in 0.2.5.2-alpha] <a id="control-spec.txt-4.1.24"></a> + ### Token buckets refilled The syntax is: @@ -1580,6 +1606,7 @@ These events are only generated if TestingTorNetwork is set. [First added in 0.2.5.2-alpha] <a id="control-spec.txt-4.1.25"></a> + ### HiddenService descriptors The syntax is: @@ -1653,6 +1680,7 @@ The syntax is: ``` <a id="control-spec.txt-4.1.26"></a> + ### HiddenService descriptors content The syntax is: @@ -1690,6 +1718,7 @@ this event will reply either the descriptor's content or an empty one. [HS v3 support added 0.3.3.1-alpha] <a id="control-spec.txt-4.1.27"></a> + ### Network liveness has changed Syntax: @@ -1705,6 +1734,7 @@ Syntax: ``` <a id="control-spec.txt-4.1.28"></a> + ### Pluggable Transport Logs Syntax: @@ -1733,6 +1763,7 @@ Syntax: ``` <a id="control-spec.txt-4.1.29"></a> + ### Pluggable Transport Status Syntax: @@ -1761,4 +1792,3 @@ Syntax: [PT_STATUS was added in Tor 0.4.0.1-alpha] ``` - |