package mtime
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=a6619f1a3f1a5b32b7a9a067b939f94e6c66244eb90762d41f2cb1c9af852dd7d270fedb20e2b9b61875d52ba46e24af6ebf5950d1284b0b75b2fd2c380d9af3
doc/mtime.clock/Mtime_clock/index.html
Module Mtime_clock
Monotonic time clock.
Mtime_clock provides access to a system monotonic clock. This time increases monotonically and is not subject to operating system calendar time adjustments.
Only use Mtime_clock.now if you need inter-process time correlation, otherwise prefer Mtime_clock.elapsed and counters.
Consult important information about error handling and platform support.
Monotonic clock
val elapsed : unit -> Mtime.spanelapsed () is the monotonic time span elapsed since the beginning of the program.
Raises Sys_error, see error handling
val now : unit -> Mtime.tnow () is the current system-relative monotonic timestamp. Its absolute value is meaningless.
Raises Sys_error, see error handling
val period : unit -> Mtime.span optionperiod () is the clock's period as a monotonic time span (if available).
Time counters
val counter : unit -> countercounter () is a counter counting from now on.
Raises Sys_error, see error handling
val count : counter -> Mtime.spancount c is the monotonic time span elapsed since c was created.
Monotonic clock raw interface
elapsed_ns () is the unsigned 64-bit integer nanosecond monotonic time span elapsed since the beginning of the program.
Raises Sys_error, see error handling
now_ns () is an unsigned 64-bit integer nanosecond system-relative monotonic timestamp. The absolute value is meaningless.
Raises Sys_error, see error handling
period_ns () is the clock's period as an unsigned 64-bit integer nanosecond monotonic time span (if available).
Error handling
The functions elapsed, now, counter, elapsed_ns and now_ns raise Sys_error whenever they can't determine the current time or that it doesn't fit in Mtime's range. Usually this exception should only be catched at the toplevel of your program to log it and abort the program. It indicates a serious error condition in the system.
All the other functions, whose functionality is less essential, simply silently return None if they can't determine the information either because it is unavailable or because an error occured.
Platform support
- Linux uses
clock_gettimewith CLOCK_BOOTTIME. This means that sleep time is taken into account. - Platforms with a POSIX clock use
clock_gettimewith CLOCK_MONOTONIC. - Darwin uses
mach_continous_time. This means that sleep time is taken into account. - Windows uses Performance counters.
- JavaScript uses
performance.now(consult availability) which returns a double floating point value in milliseconds with resolution up to the microsecond. - JavaScript running on Node.js uses the built-in
perf_hooksmodule, which provides an interface compatible to theperformancemodule in browsers.