Document TIME_CREATED field of CIRC/CIRC2 events

This commit is contained in:
Robert Ransom 2011-06-27 15:44:32 -07:00
parent c2627218b1
commit ca3f983039

View File

@ -1084,6 +1084,7 @@
"650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
[SP "BUILD_FLAGS=" BuildFlags] [SP "PURPOSE=" Purpose]
[SP "HS_STATE=" HSState] [SP "REND_QUERY=" HSAddress]
[SP "TIME_CREATED=" TimeCreated]
[SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
CircStatus =
@ -1116,6 +1117,10 @@
HSAddress = 16*Base32Character
Base32Character = ALPHA / "2" / "3" / "4" / "5" / "6" / "7"
TimeCreated = Seconds "," MicroSeconds
Seconds = 1*DIGIT
Microseconds = 1*DIGIT
Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
"HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
"OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
@ -1176,6 +1181,11 @@
MUST accept hidden service addresses in formats other than that
specified above.
The "TIME_CREATED" field is provided only in versions 0.2.3.2-alpha
and later. Seconds is the tv_sec field of a 'struct timeval';
Microseconds is the tv_usec field. TIME_CREATED is the time at
which the circuit was created or cannibalized.
The "REASON" field is provided only for FAILED and CLOSED events, and only
if extended events are enabled (see 3.19). Clients MUST accept reasons
not listed above. Reasons are as given in tor-spec.txt, except for:
@ -1916,6 +1926,7 @@
"650" SP "CIRC2" SP CircuitID SP CircEvent [SP Path]
[SP "BUILD_FLAGS=" BuildFlags] [SP "PURPOSE=" Purpose]
[SP "HS_STATE=" HSState] [SP "REND_QUERY=" HSAddress]
[SP "TIME_CREATED=" TimeCreated]
[SP "OLD_PURPOSE=" Purpose [SP "OLD_HS_STATE=" HSState]] CRLF
CircEvent =