package eio

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Writing events
Consuming events

package eio

eio
- Eio
  - Buf_read
    
    BE
    
    LE
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    Pi
    
    MGR
  - 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
  - Fd
  - Net
    
    Ipaddr
  - Pi
    
    DATAGRAM_SOCKET
    
    FLOW
    
    LISTENING_SOCKET
    
    STREAM_SOCKET
  - Private
    
    Rcfd
  - 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

This library is used to write event traces using OCaml's runtime events infrastructure.

type id = int

type ty =

| Fiber
| Promise
| Semaphore
| Switch
| Stream
| Mutex
(*
Types of recorded objects.
*)

val ty_to_string : ty -> string

Writing events

val create : (id * ty) Runtime_events.User.t

val log : string Runtime_events.User.t

val name : (id * string) Runtime_events.User.t

val resolve : id Runtime_events.User.t

val resolve_error : (id * exn) Runtime_events.User.t

val fiber : id Runtime_events.User.t

val read : id Runtime_events.User.t

val try_read : id Runtime_events.User.t

val signal : id Runtime_events.User.t

val suspend : Runtime_events.Type.span Runtime_events.User.t

Consuming events

type 'a handler = int -> Runtime_events.Timestamp.t -> 'a -> unit

A 'a handler is a function for handling events of type 'a. It is called as handler ring_id ts value.

val add_callbacks : 
  ?create:(id * ty) handler ->
  ?read:id handler ->
  ?try_read:id handler ->
  ?resolve:id handler ->
  ?resolve_error:(id * string) handler ->
  ?name:(id * string) handler ->
  ?log:string handler ->
  ?fiber:id handler ->
  ?signal:id handler ->
  ?suspend:Runtime_events.Type.span handler ->
  Runtime_events.Callbacks.t ->
  Runtime_events.Callbacks.t