GitHub is NOT the preferred viewer for this file. Please visit https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_23.html
This specification describes a simple string format used to represent a duration of time.
| Name | github.com/flux-framework/rfc/spec_23.rst |
| Editor | Mark A. Grondona <[email protected]> |
| State | raw |
Many Flux utilities and services may take a time duration as input either via user-provided options, configuration input, or message payload contents. To provide a consistent interface, and reduce the chance of incompatibility between Flux components, it is useful to standardize on a duration format that is human readable, easily parsed, and compact.
Utilities and services that support the duration form described here are said to support "Flux Standard Duration."
A Flux Standard Duration SHALL be a string of the form N[SUFFIX],
where N is a floating point number and SUFFIX is an OPTIONAL unit.
N SHALL have a range of [0:infinity] and SHALL be in a form allowed by
C99 [1] strtof or strtod.
The OPTIONAL unit suffix MUST be one of the following (case sensitive):
| Suffix | Name | Multiplier |
|---|---|---|
| ms | milliseconds | 1E-3 |
| s | seconds | 1 |
| m | minutes | 60 |
| h | hours | 3600 |
| d | days | 86400 |
If no suffix is specified, N is assumed to be in seconds.
As a special case, when N is infinity or inf, the unit suffix SHALL
be omitted.
| FSD string | duration (seconds) |
|---|---|
| 2ms | 0.002 |
| 0.1s | 0.1 |
| 30 | 30 |
| 1.2h | 4320 |
| 5m | 300 |
| 0s | 0 |
| 5d | 432000 |
| inf | INFINITY [2] |
| INF | INFINITY |
| infinity | INFINITY |
| [1] | C99 - ISO/IEC 9899:1999 standard section 7.20.1.3: The strtod, strtof, and strtold functions |
| [2] | C99 - ISO/IEC 9899:1999 standard section 7.12/4 INFINITY (p: 212-213) |