package eio

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

Module Eio_mock.ClockSource

A mock Eio.Time clock for testing timeouts.

Note that Backend.run_full provides mock clocks that advance automatically when there is nothing left to do.

Sourcetype 'time ty = [
  1. | `Mock
  2. | 'time Eio.Time.clock_ty
]
Sourcemodule type S = sig ... end
include S with type time := float
Sourcetype t = float ty Eio.Std.r
Sourceval make : unit -> t

make () is a new clock.

The time is initially set to 0.0 and doesn't change except when you call advance or set_time.

Sourceval advance : t -> unit

advance t sets the time to the next scheduled event (adding any due fibers to the run queue).

Sourceval try_advance : t -> bool

Like advance, but returns false instead of raising an exception.

Sourceval set_time : t -> float -> unit

set_time t time sets the time to time (adding any due fibers to the run queue).

Sourcemodule Mono : S with type time := Mtime.t
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