package async_unix

You can search for identifiers within the package.

in-package search v0.2.0

async_unix
- Async_unix
  - Async_config
  - Busy_poller
    
    Empty_poller
    
    Extra_poller
    
    S
  - Clock
    
    Event
    
    Status
    
    Or_timeout
  - Dump_core_on_job_delay
    
    How_to_dump
  - Fd
    
    Close
    
    Kind
  - In_thread
    
    Helper_thread
    
    Priority
    
    When_finished
  - Io_stats
  - Io_uring
  - Io_uring_raw
    
    Clock
    
    Handle
    
    Int63
    
    Open_flags
    
    Poll_mask
    
    Resolve
    
    Statx
    
    Attr
    
    Flags
    
    Mask
    
    Syscall_result
  - Io_uring_raw_singleton
  - LargeFile
  - Overwrite_
  - Print
  - Printf
  - Process
    
    Aliases
    
    For_tests
    
    Lines_or_sexp
    
    Output
    
    Stable
    
    V1
  - Reader
    
    For_testing
    
    Id
    
    For_testing
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Read_result
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Require_explicit_time_source
    
    Clock
    
    Event
    
    Status
    
    Or_timeout
    
    Date
    
    Scheduler
    
    Time
    
    Ofday
    
    Time_float
    
    Ofday
    
    Time_ns
    
    Ofday
  - Scheduler
    
    External
    
    For_metrics
    
    Thread_pool_stats_subscription
    
    For_tests
    
    Which_watcher
    
    Custom
    
    S
    
    Check_result
    
    Pre
  - Sexp
  - Shutdown
    
    Maybe_status
    
    Status
  - Signal
  - Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
  - Sys
  - Tcp
    
    Aliases
    
    Bind_to_address
    
    Bind_to_port
    
    Server
    
    Where_to_connect
    
    Where_to_listen
  - Thread_safe
    
    For_tests
  - Unix
    
    Addr_info
    
    Blocking_sexp
    
    File_kind
    
    Map
    
    Diff
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Group
    
    Host
    
    Inet_addr
    
    Lock
    
    Lock_mechanism
    
    Lock_mode
    
    Name_info
    
    Passwd
    
    Private
    
    Wait
    
    Protocol_family
    
    Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
    
    Stats
    
    Terminal_io
  - Writer
    
    Backing_out_channel
    
    Destroy_or_keep
    
    Flush_result
    
    Id
    
    For_testing
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Line_ending
    
    Terminate_with
async_unix.thread_pool
- Thread_pool
async_unix.thread_safe_ivar
- Thread_safe_ivar
async_unix.thread_safe_pipe
- Thread_safe_pipe
  - If_closed
  - Written_or_closed

Legend:
Library
Module
Module type
Parameter
Class
Class type

Instead of calling Scheduler.go, the External module can be used to drive Async with an external loop, manually running regular Async cycles. This is useful to integrate Async with another event loop system.

val run_one_cycle : 
  max_wait:[ `Zero | `Until of Time_ns_unix.t | `Indefinite ] ->
  (Core_unix.File_descr.t * Read_write_pair.Key.t) list

Run a single Async cycle. This function must be called:

from the same thread every time
nonrecursively
while holding the Async lock
regularly, to ensure Async callbacks get run

Whether this function may block is controlled by the max_wait parameter. Note that e.g. run_one_cycle ~max_wait:(`Until t) may return:

before t, if something occurs that wakes up Async, such as activity on a file descriptor, a timeout occurring, or reaching max_inter_cycle_timeout

after t, if there are Async jobs to run and some of them take a long time. That is, max_wait only controls the time spent blocking, not the time spent running jobs.

Returns a collection of readiness events on file descriptors registered via register_fd below

val run_cycles_until_determined : 'a Async_kernel.Deferred.t -> 'a

Calls run_one_cycle zero or more times until the given Deferred is determined

val current_thread_can_cycle : unit -> bool

Returns true if the current thread can use run_one_cycle. Returns false if the Async scheduler is running in another thread. Must not be called from within Async. Must be called while holding the Async lock.

val register_fd : 
  Core_unix.File_descr.t ->
  bool Read_write_pair.t ->
  unit Core.Or_error.t

Register a file descriptor for which run_one_cycle will return readiness events. Async will not do any I/O or close this descriptor.

val unregister_fd : Core_unix.File_descr.t -> unit Core.Or_error.t

Remove a registration added by register_fd

val is_registered : Core_unix.File_descr.t -> bool

Check whether a file descriptor is currently registered via register_fd