async_kernel v0.16.0 · OCaml Package

async_kernel

Internal to Async -- see Async_unix.Scheduler for the public API.

module Deferred : sig ... end

type t

val sexp_of_t : t -> Sexplib0.Sexp.t

val t : unit -> t

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

val invariant : t Base__Invariant_intf.inv

val current_execution_context : t -> Execution_context.t

val with_execution_context : t -> Execution_context.t -> f:(unit -> 'a) -> 'a

val with_execution_context1 : 
  t ->
  Execution_context.t ->
  f:('a -> 'b) ->
  'a ->
  'b

val set_execution_context : t -> Execution_context.t -> unit

val enqueue : t -> Execution_context.t -> ('a -> unit) -> 'a -> unit

val create_job : 
  t ->
  Execution_context.t ->
  ('a -> unit) ->
  'a ->
  (Async_kernel__.Types.Execution_context.t,
    Stdlib.Obj.t ->
    unit,
    Stdlib.Obj.t)
    Tuple_pool.Slots.t3
    Tuple_pool.Pointer.t

val enqueue_job : 
  t ->
  (Async_kernel__.Types.Execution_context.t,
    Stdlib.Obj.t ->
    unit,
    Stdlib.Obj.t)
    Tuple_pool.Slots.t3
    Tuple_pool.Pointer.t ->
  free_job:bool ->
  unit

val free_job : 
  t ->
  (Async_kernel__.Types.Execution_context.t,
    Stdlib.Obj.t ->
    unit,
    Stdlib.Obj.t)
    Tuple_pool.Slots.t3
    Tuple_pool.Pointer.t ->
  unit

val main_execution_context : Execution_context.t

val cycle_start : t -> Core.Time_ns.t

val run_cycle : t -> unit

val run_cycles_until_no_jobs_remain : unit -> unit

val has_upcoming_event : t -> bool

val next_upcoming_event : t -> Core.Time_ns.t option

val next_upcoming_event_exn : t -> Core.Time_ns.t

val event_precision : t -> Core.Core_private.Time_ns_alternate_sexp.Span.t

val uncaught_exn : t -> Core.Error.t option

val uncaught_exn_unwrapped : t -> (Core.Exn.t * Core.Sexp.t) option

val num_pending_jobs : t -> int

val num_jobs_run : t -> int

val last_cycle_num_jobs : t -> int

val map_cycle_times : 
  t ->
  f:(Core.Core_private.Time_ns_alternate_sexp.Span.t -> 'a) ->
  'a Tail.Stream.t

val cycle_num_jobs : t -> int Tail.Stream.t

val cycle_count : t -> int

val total_cycle_time : t -> Core.Core_private.Time_ns_alternate_sexp.Span.t

val max_num_jobs_per_priority_per_cycle : t -> int

val set_max_num_jobs_per_priority_per_cycle : t -> int -> unit

val set_check_access : t -> (unit -> unit) option -> unit

val check_access : t -> unit

val check_invariants : t -> bool

val set_check_invariants : t -> bool -> unit

val set_record_backtraces : t -> bool -> unit

val run_every_cycle_start : t -> f:(unit -> unit) -> unit

val run_every_cycle_end : t -> f:(unit -> unit) -> unit

val add_every_cycle_start_hook : 
  t ->
  f:(unit -> unit) ->
  Async_kernel__.Types.Cycle_hook_handle.t

val add_every_cycle_end_hook : 
  t ->
  f:(unit -> unit) ->
  Async_kernel__.Types.Cycle_hook_handle.t

val remove_every_cycle_start_hook_exn : 
  t ->
  Async_kernel__.Types.Cycle_hook_handle.t ->
  unit

val remove_every_cycle_end_hook_exn : 
  t ->
  Async_kernel__.Types.Cycle_hook_handle.t ->
  unit

val last_cycle_time : t -> Core.Core_private.Time_ns_alternate_sexp.Span.t

val long_cycles : 
  t ->
  at_least:Core.Core_private.Time_ns_alternate_sexp.Span.t ->
  Core.Core_private.Time_ns_alternate_sexp.Span.t Tail.Stream.t

val can_run_a_job : t -> bool

val create_alarm : t -> (unit -> unit) -> Core.Gc.Expert.Alarm.t

val add_finalizer : 
  t ->
  'a Core.Heap_block.t ->
  ('a Core.Heap_block.t -> unit) ->
  unit

val add_finalizer_exn : t -> 'a -> ('a -> unit) -> unit

val add_finalizer_last : t -> 'a Core.Heap_block.t -> (unit -> unit) -> unit

val add_finalizer_last_exn : t -> 'a -> (unit -> unit) -> unit

val set_thread_safe_external_job_hook : t -> (unit -> unit) -> unit

val set_job_queued_hook : t -> (Priority.t -> unit) -> unit

val set_event_added_hook : t -> (Core.Time_ns.t -> unit) -> unit

val backtrace_of_first_job : t -> Core.Backtrace.t option

val thread_safe_enqueue_external_job : 
  t ->
  Execution_context.t ->
  ('a -> unit) ->
  'a ->
  unit

val force_current_cycle_to_end : t -> unit

type 'a with_options := ?monitor:Monitor.t -> ?priority:Priority.t -> 'a

val within' : ((unit -> 'a Deferred.t) -> 'a Deferred.t) with_options

val within : ((unit -> unit) -> unit) with_options

val within_v : ((unit -> 'a) -> 'a option) with_options

val schedule' : ((unit -> 'a Deferred.t) -> 'a Deferred.t) with_options

val schedule : ((unit -> unit) -> unit) with_options

val preserve_execution_context : ('a -> unit) -> ('a -> unit) Core.Staged.t

val preserve_execution_context' : 
  ('a -> 'b Deferred.t) ->
  ('a -> 'b Deferred.t) Core.Staged.t

val within_context : 
  Execution_context.t ->
  (unit -> 'a) ->
  ('a, unit) Core.Result.t

val find_local : 'a Core.Univ_map.Key.t -> 'a option

val with_local : 'a Core.Univ_map.Key.t -> 'a option -> f:(unit -> 'b) -> 'b

val make_async_unusable : unit -> unit

val reset_in_forked_process : unit -> unit

val yield : t -> unit Deferred.t

val yield_every : n:int -> (t -> unit Deferred.t) Core.Staged.t

val yield_until_no_jobs_remain : 
  ?may_return_immediately:bool ->
  t ->
  unit Deferred.t

module Very_low_priority_work : sig ... end

package async_kernel