Up

module Config

: sig

Settings that globally affect the behavior of Async.

These can be set by setting an environment variable, ASYNC_CONFIG, to a sexp representation of the config. Also, setting ASYNC_CONFIG to an invalid sexp (e.g. the empty string), will cause your program to print to stderr a usage message describing how to configure ASYNC_CONFIG, and exit nonzero. For example, the following shell command should print the usage message:

      ASYNC_CONFIG= foo.exe
#
module Epoll_max_ready_events : Core.Std.Validated with type raw := int
#
module Max_inter_cycle_timeout : Core.Std.Validated with type raw := Core.Std.Time.Span.t
#
module Max_num_threads : Core.Std.Validated with type raw := int
#
module Max_num_jobs_per_priority_per_cycle : Core.Std.Validated with type raw := int
#
module Max_num_open_file_descrs : sig
include Core.Std.Validated with type raw := int
include Core.Std.Equal.S with type t := t
#
val default : t
end
#
module Dump_core_on_job_delay : sig
#
type watch = {
# dump_if_delayed_by
: Core.Std.Time.Span.t;
# how_to_dump
: [
| `Default
| `Call_abort
| `Call_gcore
]
;
}
#
type t =
# | Watch of watch
# | Do_not_watch
#
val watch_of_sexp : Sexplib.Sexp.t -> watch
#
val sexp_of_watch : watch -> Sexplib.Sexp.t
#
val t_of_sexp : Sexplib.Sexp.t -> t
#
val sexp_of_t : t -> Sexplib.Sexp.t
end
#
type t
#
val t : t
#
val environment_variable : string
#
module Print_debug_messages_for : sig
#
val clock : bool
#
val fd : bool
#
val file_descr_watcher : bool
#
val finalizers : bool
#
val interruptor : bool
#
val monitor : bool
#
val monitor_send_exn : bool
#
val parallel : bool
#
val reader : bool
#
val scheduler : bool
#
val shutdown : bool
#
val thread_pool : bool
#
val thread_safe : bool
#
val writer : bool
end
#
module File_descr_watcher : sig
#
type t =
# | Epoll_if_timerfd
# | Epoll
# | Select
#
val sexp_of_t : t -> Sexplib.Sexp.t
end
#
val abort_after_thread_pool_stuck_for : Core.Std.Time.Span.t

Documentation on these is in strings in config.ml, so it can be output in the help message.

#
val check_invariants : bool
#
val detect_invalid_access_from_thread : bool
#
val dump_core_on_job_delay : Dump_core_on_job_delay.t
#
val epoll_max_ready_events : Epoll_max_ready_events.t
#
val file_descr_watcher : File_descr_watcher.t
#
val max_inter_cycle_timeout : Max_inter_cycle_timeout.t
#
val max_num_jobs_per_priority_per_cycle : Max_num_jobs_per_priority_per_cycle.t
#
val max_num_open_file_descrs : Max_num_open_file_descrs.t
#
val max_num_threads : Max_num_threads.t
#
val record_backtraces : bool
#
val report_thread_pool_stuck_for : Core.Std.Time.Span.t
#
val timing_wheel_config : Core.Std.Timing_wheel.Config.t
#
val sexp_of_t : t -> Sexplib.Sexp.t
end