package core_unix

  1. Overview
  2. Docs
package core_unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Clock : sig ... end

Clock used to mark the progress of a timer.

module Flags : sig ... end
type t = private Core_unix.File_descr.t
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t -> t -> int
val sexp_of_t : t -> Sexplib0.Sexp.t
val to_file_descr : t -> Core_unix.File_descr.t
val create : (?flags:Flags.t -> Clock.t -> t) Core.Or_error.t

create ?flags clock creates a new timer file descriptor. With Linux 2.6.26 or earlier, flags must be empty.

val set_at : t -> Core.Time_ns.t -> unit

set_at t at and set_after t span set t to fire once, at at or after span. set_after treats span <= 0 as span = 1ns; unlike the underlying system call, timerfd_settime, it does not clear the timer if span = 0. To clear a timerfd, use Timerfd.clear.

set_repeating ?after t interval sets t to fire every interval starting after after (default is interval), raising if interval <= 0.

set_repeating_at t start interval sets t to fire every interval starting at start and raising if interval <= 0. A start time in the past will cause the timer to start immediately.

val set_after : t -> Core.Time_ns.Span.t -> unit
val set_repeating : ?after:Core.Time_ns.Span.t -> t -> Core.Time_ns.Span.t -> unit
val set_repeating_at : t -> Core.Time_ns.t -> Core.Time_ns.Span.t -> unit
val clear : t -> unit

clear t causes t to not fire anymore.

type repeat = {
  1. fire_after : Core.Time_ns.Span.t;
  2. interval : Core.Time_ns.Span.t;
}
val get : t -> [ `Not_armed | `Fire_after of Core.Time_ns.Span.t | `Repeat of repeat ]

get t returns the current state of the timer t.