package eio

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Types

package eio

eio
- Eio
  - Buf_read
    
    BE
    
    LE
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    Pi
    
    MGR
  - Executor_pool
  - Exn
    
    Backend
  - Fiber
    
    List
  - File
    
    Pi
    
    READ
    
    WRITE
    
    Stat
    
    Unix_perm
  - Flow
    
    Pi
    
    SHUTDOWN
    
    SINK
    
    SOURCE
    
    TWO_WAY
  - Fs
    
    Pi
    
    DIR
  - Lazy
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Pi
    
    DATAGRAM_SOCKET
    
    LISTENING_SOCKET
    
    NETWORK
    
    STREAM_SOCKET
    
    Sockaddr
  - Path
  - Pool
  - Private
    
    Broadcast
    
    Cells
    
    CELL
    
    Make
    
    Cell
    
    Debug
    
    Dla
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Trace
  - Process
    
    Pi
    
    MGR
    
    PROCESS
  - Promise
  - Resource
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Mono
    
    Pi
    
    CLOCK
    
    Timeout
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
    
    Mono
    
    S
  - Domain_manager
  - Flow
  - Handler
  - Net
eio.runtime_events
- Eio_runtime_events
eio.unix
- Eio_unix
  - Cap
  - Fd
  - Net
    
    Ipaddr
  - Pi
    
    DATAGRAM_SOCKET
    
    FLOW
    
    LISTENING_SOCKET
    
    STREAM_SOCKET
  - Private
    
    Rcfd
    
    Thread_pool
  - Process
    
    Make_mgr
    
    X
    
    Pi
    
    MGR
  - Resource
  - Stdenv
eio.utils
- Eio_utils
  - Lf_queue
  - Suspended
  - Zzz
    
    Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

Spawning child processes with extra control.

This extends the Eio.Process API with more control over file-descriptors.

Types

These extend the types in Eio.Process with support for file descriptors.

type ty = [ `Generic | `Unix ] Eio.Process.ty

type 'a t = [> ty ] as 'a Eio.Std.r

type mgr_ty = [ `Generic | `Unix ] Eio.Process.mgr_ty

type 'a mgr = [> mgr_ty ] as 'a Eio.Std.r

module Pi : sig ... end

module Make_mgr
  (X : sig ... end) : 
  Pi.MGR with type t = X.t and type tag = [ `Generic | `Unix ]

val spawn_unix : 
  sw:Eio.Std.Switch.t ->
  _ mgr ->
  ?cwd:Eio.Fs.dir_ty Eio.Path.t ->
  fds:(int * Fd.t * Private.Fork_action.blocking) list ->
  ?env:string array ->
  ?executable:string ->
  string list ->
  ty Eio.Std.r

spawn_unix ~sw mgr ~fds args spawns a child process running the command args.

The arguments are as for Eio.Process.spawn, except that it takes a list of FD mappings for Fork_action.inherit_fds directly, rather than just flows for the standard streams.

val sigchld : Eio.Condition.t

If an Eio backend installs a SIGCHLD handler, the handler will broadcast on this condition.

This allows non-Eio libraries (such as Lwt) to share its signal handler.

Note: Not all backends install a handler (e.g. eio_linux uses process descriptors instead), so be sure to call install_sigchld_handler if you need to use this.

val install_sigchld_handler : unit -> unit

install_sigchld_handler () sets the signal handler for SIGCHLD to broadcast sigchld.