aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2021-12-08 11:10:05 -0500
committerNick Mathewson <nickm@torproject.org>2021-12-08 11:10:05 -0500
commit0911bbd0cdb5459dd0eb948694f98066712cd084 (patch)
tree5c549563af6177811b165ec8de4c30d660ba1aaf
parent583d028d4a637e1c0eabeb331a3a8bf4d775d15d (diff)
downloadtorspec-0911bbd0cdb5459dd0eb948694f98066712cd084.tar.gz
torspec-0911bbd0cdb5459dd0eb948694f98066712cd084.zip
Clarify the behavior of some circuit timeout params.
In particular, this commit clarifies that the ranges of some parameters are such that choosing a very high value will, in effect, disable parts of the circuit timeout inference code.
-rw-r--r--path-spec.txt14
1 files changed, 12 insertions, 2 deletions
diff --git a/path-spec.txt b/path-spec.txt
index 4422be4..33d50e5 100644
--- a/path-spec.txt
+++ b/path-spec.txt
@@ -633,8 +633,8 @@ Tables of Contents
Default: 20
Min: 3
Max: 1000
- Effect: This is the number of circuit build times to keep track of
- for the following option.
+ Effect: This is the number of circuit build outcomes (success vs
+ timeout) to keep track of for the following option.
cbtmaxtimeouts
Default: 18
@@ -644,6 +644,10 @@ Tables of Contents
circuit attempts, the client should discard all of its
history and begin learning a fresh timeout value.
+ Note that if this parameter's value is greater than the value
+ of 'cbtrecentcount', then the history will never be
+ discarded because of this feature.
+
cbtmincircs
Default: 100
Min: 1
@@ -651,6 +655,12 @@ Tables of Contents
Effect: This is the minimum number of circuits to build before
computing a timeout.
+ Note that if this parameter's value is higher than 1000 (the
+ number of time observations that a client keeps in its
+ circular buffer), circuit build timeout calculation is
+ effectively disabled, and the default timeouts are used
+ indefinitely.
+
cbtquantile
Default: 80
Min: 10