package eio

  1. Overview
  2. Docs
On This Page
  1. Timeouts
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (19)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.3.tbz
sha256=8ed5c13e6689f31c85dca5f12762d84b8cc0042a7b07d3e464df6eb4b72b3dfc
sha512=46e8f817f32c3316e7f35835a136ad177a295b3306351eb2efa2386482b0169a5b19ed2925b32da2a1f10d40f083fe3d588dd401908f9fec6e4a44cd68535204

doc/eio/Eio/Time/index.html

Module Eio.TimeSource

Clocks, time, sleeping and timeouts.

Sourcetype 'a clock_ty = [
  1. | `Clock of 'a
]
Sourcetype 'a clock_base = 'a Std.r constraint 'a = [> _ clock_ty ]
Sourcetype 'a clock = ([> float clock_ty ] as 'a) Std.r
Sourceval now : _ clock -> float

now t is the current time since 00:00:00 GMT, Jan. 1, 1970 - in seconds - according to t.

Sourceval sleep_until : _ clock -> float -> unit

sleep_until t time waits until the given time is reached.

Sourceval sleep : _ clock -> float -> unit

sleep t d waits for d seconds.

Sourcemodule Mono : sig ... end

Monotonic clocks.

Timeouts

Sourceexception Timeout
Sourceval with_timeout : _ clock -> float -> (unit -> ('a, 'e) result) -> ('a, [> `Timeout ] as 'e) result

with_timeout clock d fn runs fn () but cancels it after d seconds.

Sourceval with_timeout_exn : _ clock -> float -> (unit -> 'a) -> 'a

with_timeout_exn clock d fn runs fn () but cancels it after d seconds, raising exception Timeout.

Sourcemodule Timeout : sig ... end

Timeout values.

Sourcemodule Pi : sig ... end