package core

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (13)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.14.1.tar.gz
sha256=8c158c12345d36a5cdd71081728f4317b2b04c09eb4126b6de00c482a6fec2a0
md5=b11f58205953d84cedb0003efcdab231

doc/core.linux_ext/Linux_ext/Timerfd/index.html

Module Linux_ext.Timerfd

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
val compare : t -> t -> int
val sexp_of_t : t -> Ppx_sexp_conv_lib.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.

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 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.