aboutsummaryrefslogtreecommitdiff
path: root/control-spec.txt
diff options
context:
space:
mode:
authorMike Perry <mikeperry-git@torproject.org>2018-04-23 20:28:12 +0000
committerMike Perry <mikeperry-git@torproject.org>2018-04-26 18:04:18 +0000
commitfbb38ec724e595ffc3a8b7ec9a4eac26e7c9f6ab (patch)
treedf202205553f7ea2557ecfbe93dd3042029aba06 /control-spec.txt
parentd88afa188ed10d30e43b3377ff0c8a47ac4916e9 (diff)
downloadtorspec-fbb38ec724e595ffc3a8b7ec9a4eac26e7c9f6ab.tar.gz
torspec-fbb38ec724e595ffc3a8b7ec9a4eac26e7c9f6ab.zip
Document new CIRC_BW fields.
Diffstat (limited to 'control-spec.txt')
-rw-r--r--control-spec.txt25
1 files changed, 21 insertions, 4 deletions
diff --git a/control-spec.txt b/control-spec.txt
index e2f749e..fb693e5 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -2926,14 +2926,31 @@
The syntax is:
"650" SP "CIRC_BW" SP "ID=" CircuitID SP "READ=" BytesRead SP
- "WRITTEN=" BytesWritten SP "TIME=" Time CRLF
+ "WRITTEN=" BytesWritten SP "TIME=" Time SP
+ "DELIVERED_READ=" DeliveredBytesRead SP
+ "OVERHEAD_READ=" OverheadBytesRead SP
+ "DELIVERED_WRITTEN=" DeliveredBytesWritten CRLF
+ "OVERHEAD_WRITTEN=" OverheadBytesWritten SP
BytesRead = 1*DIGIT
BytesWritten = 1*DIGIT
+ OverheadBytesRead = 1*DIGIT
+ OverheadBytesWritten = 1*DIGIT
+ DeliveredBytesRead = 1*DIGIT
+ DeliveredBytesWritten = 1*DIGIT
Time = ISOTime2Frac
- BytesRead and BytesWritten are the number of bytes read and written by
- all applications with streams attached to this circuit since the last
- CIRC_BW event.
+ BytesRead and BytesWritten are the number of bytes read and written
+ on this circuit since the last CIRC_BW event.
+
+ DeliveredBytesRead and DeliveredBytesWritten are the total length of
+ all valid relay cell payloads read and written on this circuit since
+ the last CIRC_BW event. These fields are provided only in Tor
+ 3.4.0-alpha and later.
+
+ OverheadBytesRead and OverheadBytesWritten are the total length of
+ the unused overhead portion of valid relay cells read and written on
+ this circuit since the last CIRC_BW event. These fields are provided
+ only in Tor 0.3.4.0-alpha and later.
The Time field is provided only in versions 0.3.2.1-alpha and later. It
records when Tor created the bandwidth event.