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

A thread-safe pipe is a thread-safe interface to the write end of a normal Async.Pipe. All operations except for create must be called from threads outside Async, while create can be called from inside or outside Async.

For Pipe functions that return a unit Deferred.t, the analog in Thread_safe_pipe blocks.

For documentation of wakeup_scheduler, see the Thread_safe module.

type 'a t

The writer end of the pipe.

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

val create : unit -> 'a Async_kernel.Pipe.Reader.t * 'a t

create () returns a reader end, which must be used inside Async, and a writer end, which must be used outside Async. create can be called inside or outside Async.

All the following functions must be called outside Async. They behave as their counterpart in the Pipe module.

val pushback : _ t -> unit

pushback writer blocks the current thread until the pipe is empty or closed.

module Written_or_closed : sig ... end

module If_closed : sig ... end

Functions that write elements to the pipe take an If_closed.t argument to specify how to deal with the possibility that the pipe is closed.

val transfer_in_without_pushback : 
  ?wakeup_scheduler:bool ->
  'a t ->
  from:'a Core.Queue.t ->
  if_closed:'b If_closed.t ->
  'b

transfer_in_without_pushback' and write_without_pushback transfer the element(s) into the pipe and return immediately.

val write_without_pushback : 
  ?wakeup_scheduler:bool ->
  'a t ->
  'a ->
  if_closed:'b If_closed.t ->
  'b

val transfer_in : 
  'a t ->
  from:'a Core.Queue.t ->
  if_closed:'b If_closed.t ->
  'b

transfer_in and write transfer the element(s) into the pipe and block the current thread until the pipe is empty or closed (like pushback).

val write : 'a t -> 'a -> if_closed:'b If_closed.t -> 'b

val close : _ t -> unit

val is_closed : _ t -> bool

val closed : _ t -> unit

closed writer blocks the current thread until the pipe is closed.