package eio

  1. Overview
  2. Docs
On This Page
  1. Timeouts
package eio
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct