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__.Core_unix.File_descr.t
include Bin_prot.Binable.S with type t := t
type t
include Bin_prot.Binable.S_only_functions with type t := t
type t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
val compare : t -> t -> int
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
type t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val to_file_descr : t -> Core__.Core_unix.File_descr.t
val create : (?⁠flags:Flags.t -> Clock.t -> t) Core__.Import.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__.Import.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__.Import.Time_ns.Span.t -> unit
val set_repeating : ?⁠after:Core__.Import.Time_ns.Span.t -> t -> Core__.Import.Time_ns.Span.t -> unit
val clear : t -> unit

clear t causes t to not fire anymore.

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

get t returns the current state of the timer t.