package eio

You can search for identifiers within the package.

in-package search v0.2.0

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

A dummy Eio backend with no actual IO.

This backend does not support the use of multiple domains or systhreads, but the tradeoff is that it can reliably detect deadlock, because if the run queue is empty then it knows that no wake up event can be coming from elsewhere.

exception Deadlock_detected

val run : (unit -> 'a) -> 'a

run fn runs an event loop and then calls fn env within it.

raises Deadlock_detected
if the run queue becomes empty but fn hasn't returned.

type stdenv =
  < clock : Clock.t
  ; mono_clock : Clock.Mono.t
  ; debug : Eio.Debug.t
  ; backend_id : string >

val run_full : (stdenv -> 'a) -> 'a

run_full is like run but also provides a mock environment.

The mock monotonic clock it provides advances automatically when there is nothing left to do. The mock wall clock is linked directly to the monotonic time.