aboutsummaryrefslogtreecommitdiff
path: root/spec/bandwidth-file-spec/implementation-details.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/bandwidth-file-spec/implementation-details.md')
-rw-r--r--spec/bandwidth-file-spec/implementation-details.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/spec/bandwidth-file-spec/implementation-details.md b/spec/bandwidth-file-spec/implementation-details.md
index dc9f8c0..5491d57 100644
--- a/spec/bandwidth-file-spec/implementation-details.md
+++ b/spec/bandwidth-file-spec/implementation-details.md
@@ -1,7 +1,9 @@
<a id="bandwidth-file-spec.txt-2.4"></a>
+
## Implementation details
<a id="bandwidth-file-spec.txt-2.4.1"></a>
+
### Writing bandwidth files atomically
To avoid inconsistent reads, implementations SHOULD write bandwidth files
@@ -16,11 +18,13 @@ to the configured V3BandwidthsFile path.
Torflow does not write bandwidth files atomically.
<a id="bandwidth-file-spec.txt-2.4.2"></a>
+
### Additional KeyValue pair definitions
KeyValue pairs in RelayLines that current implementations generate.
<a id="bandwidth-file-spec.txt-2.4.2.1"></a>
+
#### Simple Bandwidth Scanner
sbws RelayLines contain these keys:
@@ -376,6 +380,7 @@ The filtered stream ratio of this relay calculated as explained in B4.3.
This KeyValue was added in version 1.7.0 of this specification.
<a id="bandwidth-file-spec.txt-2.4.2.2"></a>
+
#### Torflow
Torflow RelayLines include node_id and bw, and other KeyValue pairs [2].
@@ -391,4 +396,3 @@ References:
4. https://gitweb.torproject.org/torspec.git/tree/version-spec.txt
5. https://semver.org/
```
-