async_kernel v0.12.0 · OCaml Package

async_kernel

A synchronous version of Async_kernel.Time_source. advance_by_alarms runs alarms immediately, rather than enqueueing Async jobs.

Synchronous_time_source is a wrapper around Timing_wheel_ns. One difference is that Synchronous_time_source alarms fire in non-decreasing time order, whereas in Timing_wheel_ns that is only true for alarms in different time intervals as determined by alarm_precision.

module T1 : sig ... end

module Read_write : sig ... end

type t = Core_kernel.read T1.t

val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t

val invariant_with_jobs : 
  job:
    (Async_kernel__.Types.Execution_context.t,
      Stdlib.Obj.t ->
      unit,
      Stdlib.Obj.t)
      Core_kernel.Pool.Slots.t3
      Core_kernel.Pool.Pointer.t
      Core_kernel.Invariant.t ->
  t Core_kernel.Invariant.t

include Core_kernel.Invariant.S with type t := t

val invariant : t Base__.Invariant_intf.inv

val read_only : [> Core_kernel.read ] T1.t -> t

type callback = unit -> unit

val create : 
  ?timing_wheel_config:Core_kernel.Timing_wheel_ns.Config.t ->
  now:Core_kernel.Int63.t ->
  unit ->
  Core_kernel.read_write T1.t

create ~now () creates a new time source. The default timing_wheel_config has 100 microsecond precision, with levels of >1s, >1m, >1h, >1d. The timing_wheel_config is used to tune performance; configuration does not affect the fact that alarms fire in non-decreasing time order.

val alarm_precision : 
  [> Core_kernel.read ] T1.t ->
  Core_kernel.Core_kernel_private.Time_ns_alternate_sexp.Span.t

val is_wall_clock : [> Core_kernel.read ] T1.t -> bool

is_wall_clock reports whether this time source represents 'wall clock' time, or some alternate source of time.

val now : [> Core_kernel.read ] T1.t -> Core_kernel.Int63.t

The behavior of now is special for wall_clock (); it always calls Time_ns.now (), so it can return times that the time source has not yet been advanced to.

val timing_wheel_now : [> Core_kernel.read ] T1.t -> Core_kernel.Int63.t

Removes the special behavior of now for wall_clock (); it always returns the timing wheel's notion of now, which means that the following inequality always holds: timing_wheel_now () <= now ().

val advance_by_alarms : 
  [> Core_kernel.write ] T1.t ->
  to_:Core_kernel.Int63.t ->
  unit Core_kernel.Or_error.t

advance_by_alarms t ~to_ advances t's time to to_, running callbacks for all alarms in t whose at <= to_. Callbacks run in nondecreasing order of at. If to_ <= now t, then now t does not change (and in particular does not go backward), but alarms with at <= to_ may still may fire.

val run_at : 
  [> Core_kernel.read ] T1.t ->
  Core_kernel.Int63.t ->
  callback ->
  unit

run_at t at f schedules an alarm that will run f during the next subsequent advance_by_alarms t ~to_ that causes now t >= at. If at <= now t, then f will to run at the next call to advance_by_alarms. f is allowed to do all Synchronous_time_source operations except for advance_by_alarms (because f is already running during advance_by_alarms. Adding alarms is not zero-alloc and the underlying events live in the OCaml heap.

val run_after : 
  [> Core_kernel.read ] T1.t ->
  Core_kernel.Core_kernel_private.Time_ns_alternate_sexp.Span.t ->
  callback ->
  unit

run_after t span f is run_at t (now t + span) f.

val run_at_intervals : 
  [> Core_kernel.read ] T1.t ->
  Core_kernel.Core_kernel_private.Time_ns_alternate_sexp.Span.t ->
  callback ->
  unit

run_at_intervals t span f causes f to run at intervals now t + k * span, for k = 0, 1, 2, etc. run_at_intervals raises if span < alarm_precision t.

val alarm_upper_bound : [> Core_kernel.read ] T1.t -> Core_kernel.Int63.t

alarm_upper_bound t returns the upper bound on a Time_ns.t that can be supplied to run_at. alarm_upper_bound t is not constant; its value increases as now t increases.

deprecated [since 2018-09] Use max_allowed_alarm_time instead] instead

val max_allowed_alarm_time : [> Core_kernel.read ] T1.t -> Core_kernel.Int63.t

max_allowed_alarm_time t returns the greatest at that can be supplied to add. max_allowed_alarm_time is not constant; its value increases as now t increases.

module Event : sig ... end

val default_timing_wheel_config : Core_kernel.Timing_wheel_ns.Config.t

val wall_clock : unit -> t

A time source with now t given by wall-clock time (i.e. Time_ns.now), and automatically advanced at the start of each Async cycle. The wall clock uses the same timing wheel as that used by the Async scheduler, and is hence similarly affected by the ASYNC_CONFIG environment variable.

package async_kernel