diff options
author | Nick Mathewson <nickm@torproject.org> | 2005-08-04 19:56:41 +0000 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2005-08-04 19:56:41 +0000 |
commit | 4cb89fd557db8ac66234f94f922fd5b4a371a9e0 (patch) | |
tree | f633228bf564133260a830fa4c7f85c0d072f783 /doc | |
parent | 5b3286179cf74ad90555a352145c66428834fbb5 (diff) | |
download | tor-4cb89fd557db8ac66234f94f922fd5b4a371a9e0.tar.gz tor-4cb89fd557db8ac66234f94f922fd5b4a371a9e0.zip |
Implement some more GETINFO goodness: expose helper nodes, config options, getinfo keys.
svn:r4694
Diffstat (limited to 'doc')
-rw-r--r-- | doc/TODO | 14 | ||||
-rw-r--r-- | doc/control-spec.txt | 39 |
2 files changed, 48 insertions, 5 deletions
@@ -78,12 +78,16 @@ for 0.1.1.x: o Implement main controller interface o Glue code o Testing -N - Additional controller features - - Expose more information via getinfo +N . Additional controller features + . Expose more information via getinfo: o Accounting status - - Helper node status - - Review all static fields for candidates - - List of available getinfo/getconf fields. + o Helper node status + o Document + o Implement + o List of available getinfo/getconf fields. + o Document + o Implement + - Review all static fields for additional candidates - Allow EXTENDCIRCUIT to unknown server. - We need some way to adjust server status, and to tell tor not to download directories/network-status, and a way to force a download. diff --git a/doc/control-spec.txt b/doc/control-spec.txt index 22edad6963..9ce1f60713 100644 --- a/doc/control-spec.txt +++ b/doc/control-spec.txt @@ -325,6 +325,45 @@ $Id$ form: ServerID SP ORStatus CRLF + "helper-nodes" + A series of lines listing the currently chosen helper nodes, if any. + Each is of the form: + ServerID SP ((("down" / "unlisted") ISOTime) / "up") CRLF + + "accounting/enabled" + "accounting/hibernating" + "accounting/bytes" + "accounting/bytes-left" + "accounting/interval-start" + "accounting/interval-wake" + "accounting/interval-end" + Information about accounting status. If accounting is enabled, + "enabled" is 1; otherwise it is 0. The "hibernating" field is "hard" + if we are accepting no data; "soft" if we're accepting no new + connections, and "awake" if we're not hibernating at all. The "bytes" + and "bytes-left" fields contain (read-bytes SP write-bytes), for the + start and the rest of the interval respectively. The 'interval-start' + and 'interval-end' fields are the borders of the current interval; the + 'interval-wake' field is the time within the current interval (if any) + where we plan[ned] to start being active. + + "config/names" + A series of lines listing the available configuration options. Each is + of the form: + OptionName SP OptionType [ SP Documentation ] CRLF + OptionName = Keyword + OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" / + "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" / + "String" / "LineList" + Documentation = Text + + "info/names" + A series of lines listing the available GETINFO options. Each is of + one of thes forms: + OptionName SP Documentation CRLF + OptionPrefix SP Documentation CRLF + OptionPrefix = OptionName "/*" + Examples: C: GETINFO version desc/name/moria1 S: 250+desc/name/moria= |