Module `Async_kernel_config`Source

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

Sourcemodule Epoll_max_ready_events : Core.Validated.S with type raw := int

Source

module Max_inter_cycle_timeout : 
  Core.Validated.S with type raw := Core.Time_ns.Span.t

Source

module Min_inter_cycle_timeout : 
  Core.Validated.S with type raw := Core.Time_ns.Span.t

Sourcemodule Max_num_threads : Core.Validated.S with type raw := int

Source

module Max_num_jobs_per_priority_per_cycle : 
  Core.Validated.S with type raw := int

Sourcemodule Max_num_open_file_descrs : sig ... end

Sourcemodule Dump_core_on_job_delay : sig ... end

Sourcemodule Debug_tag : sig ... end

Sourcemodule File_descr_watcher : sig ... end

Sourcetype t = {

abort_after_thread_pool_stuck_for : Core.Time_ns.Span.t option;
check_invariants : bool option;
detect_invalid_access_from_thread : bool option;
dump_core_on_job_delay : Dump_core_on_job_delay.t option;
epoll_max_ready_events : Epoll_max_ready_events.t option;
file_descr_watcher : File_descr_watcher.t option;
max_inter_cycle_timeout : Max_inter_cycle_timeout.t option;
max_num_open_file_descrs : Max_num_open_file_descrs.t option;
max_num_threads : Max_num_threads.t option;
max_num_jobs_per_priority_per_cycle : Max_num_jobs_per_priority_per_cycle.t option;
min_inter_cycle_timeout : Min_inter_cycle_timeout.t option;
print_debug_messages_for : Debug_tag.t list option;
record_backtraces : bool option;
report_thread_pool_stuck_for : Core.Time_ns.Span.t option;
thread_pool_cpu_affinity : Thread_pool_cpu_affinity.t option;
timing_wheel_config : Timing_wheel.Config.t option;

}

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Source

val create : 
  ?abort_after_thread_pool_stuck_for:Core.Time_ns.Span.t ->
  ?check_invariants:bool ->
  ?detect_invalid_access_from_thread:bool ->
  ?dump_core_on_job_delay:Dump_core_on_job_delay.t ->
  ?epoll_max_ready_events:Epoll_max_ready_events.t ->
  ?file_descr_watcher:File_descr_watcher.t ->
  ?max_inter_cycle_timeout:Max_inter_cycle_timeout.t ->
  ?max_num_open_file_descrs:Max_num_open_file_descrs.t ->
  ?max_num_threads:Max_num_threads.t ->
  ?max_num_jobs_per_priority_per_cycle:Max_num_jobs_per_priority_per_cycle.t ->
  ?min_inter_cycle_timeout:Min_inter_cycle_timeout.t ->
  ?print_debug_messages_for:Debug_tag.t list ->
  ?record_backtraces:bool ->
  ?report_thread_pool_stuck_for:Core.Time_ns.Span.t ->
  ?thread_pool_cpu_affinity:Thread_pool_cpu_affinity.t ->
  ?timing_wheel_config:Timing_wheel.Config.t ->
  unit ->
  t

Sourceval t : t

Sourceval environment_variable : string

Sourcemodule Print_debug_messages_for : sig ... end

Sourceval abort_after_thread_pool_stuck_for : Core.Time_ns.Span.t

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

Sourceval check_invariants : bool

Sourceval detect_invalid_access_from_thread : bool

Sourceval dump_core_on_job_delay : Dump_core_on_job_delay.t

Sourceval thread_pool_cpu_affinity : Thread_pool_cpu_affinity.t

Sourceval epoll_max_ready_events : Epoll_max_ready_events.t

Sourceval file_descr_watcher : File_descr_watcher.t

Sourceval max_inter_cycle_timeout : Max_inter_cycle_timeout.t

Sourceval max_num_jobs_per_priority_per_cycle : Max_num_jobs_per_priority_per_cycle.t

Sourceval max_num_open_file_descrs : Max_num_open_file_descrs.t

Sourceval max_num_threads : Max_num_threads.t

Sourceval min_inter_cycle_timeout : Min_inter_cycle_timeout.t

Sourceval record_backtraces : bool

Sourceval report_thread_pool_stuck_for : Core.Time_ns.Span.t

Sourceval timing_wheel_config : Timing_wheel.Config.t

Source

val default_timing_wheel_config_for_word_size : 
  Core.Word_size.t ->
  Timing_wheel.Config.t

Sourceval task_id : (unit -> Core.Sexp.t) Core.ref

!task_id is used in debug messages. It is is set in Async_unix to include the thread and pid.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/async_kernel.config/Async_kernel_config/index.html

Module `Async_kernel_config`Source

package async_kernel

Install

Dune Dependency

Authors

Maintainers

Sources

doc/async_kernel.config/Async_kernel_config/index.html

Module Async_kernel_configSource

Module `Async_kernel_config`Source