diff options
Diffstat (limited to 'bandwidth-file-spec.txt')
| -rw-r--r-- | bandwidth-file-spec.txt | 47 |
1 files changed, 42 insertions, 5 deletions
diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt index da7b4b0..0b2c7af 100644 --- a/bandwidth-file-spec.txt +++ b/bandwidth-file-spec.txt @@ -118,9 +118,21 @@ It consists of: [At start, exactly once.] - The Unix Epoch time in seconds when the file was created. - It does not follow the KeyValue format for backwards - compatibility with version 1.0.0. + The Unix Epoch time in seconds of the most recent generator bandwidth + result. + + If the generator implementation has multiple threads or + subprocesses which can fail independently, it SHOULD take the most + recent timestamp from each thread and use the oldest value. This + ensures all the threads continue running. + + If there are threads that do not run continuously, they SHOULD be + excluded from the timestamp calculation. + + If there are no recent results, the generator MUST NOT generate a new file. + + It does not follow the KeyValue format for backwards compatibility + with version 1.0.0. "version=" version_number NL @@ -155,6 +167,15 @@ It consists of: This Line has been added in version 1.1.0 of this specification. + "file_created=" DateTime NL + + [Zero or one time.] + + The date and time timestamp in ISO 8601 format and UTC time zone + when the file was created. + + This Line has been added in version 1.1.0 of this specification. + "generator_started=" DateTime NL [Zero or one time.] @@ -173,6 +194,20 @@ It consists of: This Line has been added in version 1.1.0 of this specification. + "latest_bandwidth=" DateTime NL + + [Zero or one time.] + + The date and time timestamp in ISO 8601 format and UTC time zone + of the most recent generator bandwidth result. + + This time MUST be identical to the initial Timestamp line. + + This duplicate value is included to make the format easier for people + to read. + + This Line has been added in version 1.1.0 of this specification. + KeyValue NL [Zero or more times.] @@ -417,8 +452,10 @@ A.2. Generated by sbws version 0.1.X version=1.1.0 software=sbws software_version=0.1.0 -generator_started=2018-05-08T16:13:25 -earliest_bandwidth=2018-05-08T16:13:26 +latest_bandwidth=2018-04-16T20:49:18 +file_created=2018-04-16T21:49:18 +generator_started=2018-04-16T15:13:25 +earliest_bandwidth=2018-04-16T15:13:26 ==== bw=380 error_circ=0 error_misc=0 error_stream=1 master_key_ed25519=YaqV4vbvPYKucElk297eVdNArDz9HtIwUoIeo0+cVIpQ nick=Test node_id=$68A483E05A2ABDCA6DA5A3EF8DB5177638A27F80 rtt=380 success=1 time=2018-05-08T16:13:26 bw=189 error_circ=0 error_misc=0 error_stream=0 master_key_ed25519=a6a+dZadrQBtfSbmQkP7j2ardCmLnm5NJ4ZzkvDxbo0I nick=Test2 node_id=$96C15995F30895689291F455587BD94CA427B6FC rtt=378 success=1 time=2018-05-08T16:13:36 |