package tezt

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

Module Scheduler.TimerSource

Call functions after a given amount of time.

Timers trigger in the scheduler process, and only if they were created in the scheduler process. If a worker runs a scheduler itself, this worker does not inherit the timers from its parent scheduler.

Sourcetype t

Timers.

Sourceval on_delay : float -> (unit -> unit) -> t

Create a timer.

Usage: on_delay delay f

This causes run to trigger f () after delay seconds. This also causes run to not return until this timer has triggered, even if all tasks are done, unless the timer is canceled.

Sourceval cancel : t -> unit

Cancel a timer.

This removes the timer from the list of active timers. The function associated with the timer will not be triggered by run, and run will not wait for the timer to occur.

If the timer has already been triggered, this has no effect.

Sourceval cancel_all : unit -> unit

Cancel all active timers.

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