package mirage-mtime

You can search for identifiers within the package.

in-package search v0.2.0

mirage-mtime
- Library mirage-mtime.mock
  - Mirage_mtime
- Library mirage-mtime.set
  - Mirage_mtime_set
- Library mirage-mtime.solo5
  - Mirage_mtime
- Library mirage-mtime.unix
  - Mirage_mtime
- Sources
  - mirage-mtime.mock
    
    mirage_mtime.ml
    
    mirage_mtime__mirage_mtime_mock__.ml
  - mirage-mtime.set
    
    mirage_mtime_set.ml
  - mirage-mtime.solo5
    
    mirage_mtime.ml
    
    mirage_mtime__mirage_mtime_solo5__.ml
  - mirage-mtime.unix
    
    mirage_mtime.ml
    
    mirage_mtime__mirage_mtime_unix__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Mirage_mtime`Source

include module type of struct include Mtime_clock end

Monotonic clock

Sourceval elapsed : unit -> Mtime.span

elapsed () is the monotonic time span elapsed since the beginning of the program.

Raises Sys_error, see error handling

Sourceval now : unit -> Mtime.t

now () is the current system-relative monotonic timestamp. Its absolute value is meaningless.

Raises Sys_error, see error handling

Sourceval period : unit -> Mtime.span option

period () is the clock's period as a monotonic time span (if available).

Time counters

Sourcetype counter = Mtime_clock.counter

The type for monotonic wall-clock time counters.

Sourceval counter : unit -> counter

counter () is a counter counting from now on.

Raises Sys_error, see error handling

Sourceval count : counter -> Mtime.span

count c is the monotonic time span elapsed since c was created.

Monotonic clock raw interface

val elapsed_ns : unit -> int64

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

Sourceval now_ns : unit -> int64

now_ns () is an unsigned 64-bit integer nanosecond system-relative monotonic timestamp. The absolute value is meaningless.

Raises Sys_error, see error handling

val period_ns : unit -> int64 option

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_gettime with CLOCK_BOOTTIME. This means that sleep time is taken into account.
Platforms with a POSIX clock use clock_gettime with 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_hooks module, which provides an interface compatible to the performance module in browsers.

package mirage-mtime

Module Mirage_mtimeSource

Monotonic clock

Time counters

Monotonic clock raw interface

Error handling

Platform support

Module `Mirage_mtime`Source