Module CCTimer

module CCTimer: sig .. end

Event timer

Used to be part of CCFuture
Since 0.16

type t

A scheduler for events. It runs in its own thread.

val create : unit -> t

A new timer.

val set_exn_handler : t -> (exn -> unit) -> unit

set_exn_handler timer f registers f so that any exception raised by a task scheduled in timer is given to f

exception Stopped

val after : t -> float -> f:(unit -> 'a) -> unit

Call the callback f after the given number of seconds.
Raises Stopped if the timer was stopped

val at : t -> float -> f:(unit -> 'a) -> unit

Create a future that evaluates to () at the given Unix timestamp
Raises Stopped if the timer was stopped

exception ExitEvery

val every : ?delay:float -> t -> float -> f:(unit -> 'a) -> unit

every timer n ~f calls f () every n seconds. f() can raise ExitEvery to stop the cycle.
Raises Stopped if the timer was stopped

delay : if provided, the first call to f () is delayed by that many seconds.

val stop : t -> unit

Stop the given timer, cancelling pending tasks. Idempotent. From now on, calling most other operations on the timer will raise Stopped.

val active : t -> bool

Returns true until stop t has been called.