Module Ecaml.Timer
You can set up a timer to call a function at a specified future time or after a certain length of idleness.
Emacs cannot run timers at any arbitrary point in a program; it can run them only when Emacs could accept output from a subprocess: namely, while waiting or inside certain primitive functions such as sit-for
or read-event
which _can_ wait. Therefore, a timer's execution may be delayed if Emacs is busy. However, the time of execution is very precise if Emacs is idle.
(Info-goto-node "(elisp)Timers")
include Ecaml__.Import.Value.Subtype
type value
type t
= private value
We expose
private value
for free identity conversions when the value is nested in some covariant type, e.g.(symbols : Symbol.t list :> Value.t list)
rather thanList.map symbols ~f:Symbol.to_value
.
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
val eq : t -> t -> bool
eq t1 t2 = Value.eq (to_value t1) (to_value t2)
, i.e.eq
checks whether the Emacs values underlyingt1
andt2
are physically equal. This is different thanphys_equal t1 t2
, because we don't always wrapeq
Emacs values inphys_equal
OCaml values. I.e.phys_equal t1 t2
implieseq t1 t2
, but not the converse.
val is_in_subtype : value -> bool
include Ecaml_value__.Valueable0.S with type t := t
val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
val type_ : t type_
val t : t type_
val all_scheduled : unit -> t list
(describe-variable 'timer-list)
val is_scheduled : t -> bool
val run_after : ?repeat:Core_kernel.Time_ns.Span.t -> Core_kernel.Source_code_position.t -> Core_kernel.Time_ns.Span.t -> f:(unit -> unit) -> name:Symbol.t -> t
(describe-function 'run-at-time)
(Info-goto-node "(elisp)Timers")
val run_after_i : ?repeat:Core_kernel.Time_ns.Span.t -> Core_kernel.Source_code_position.t -> Core_kernel.Time_ns.Span.t -> f:(unit -> unit) -> name:Symbol.t -> unit
run_after_i s f = ignore (run_after s f)
val cancel : t -> unit
(describe-function 'cancel-timer)
(Info-goto-node "(elisp)Timers")
val sit_for : ?redisplay:bool -> Core_kernel.Time_ns.Span.t -> unit Async_kernel.Deferred.t
(describe-function 'sit-for)
(Info-goto-node "(elisp)Waiting")
val sleep_for : Core_kernel.Time_ns.Span.t -> unit Async_kernel.Deferred.t
(describe-function 'sleep-for)
(Info-goto-node "(elisp)Waiting")