package mirage-clock-freestanding

  1. Overview
  2. Docs
On This Page
  1. Monotonic clock
Legend:
Library
Module
Module type
Parameter
Class
Class type

Monotonic clock

Clock returning monotonic time since an arbitrary point. To be used for eg. profiling.

include Mirage_clock_lwt.MCLOCK
include Mirage_device.S with type t = unit with type 'a io = 'a Lwt.t
type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t = unit

The type representing the internal state of the device

val disconnect : t -> unit io

Disconnect from the device. While this might take some time to complete, it can never result in an error.

val elapsed_ns : t -> int64

elapsed_ns () is a monotonically increasing count of nanoseconds elapsed since some arbitrary point

val period_ns : t -> int64 option

period_ns () is Some ns representing the clock's nanosecond period ns, if known

val connect : unit -> t Lwt.t