package eio

  1. Overview
  2. Docs

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

type id = int
type ty =
  1. | Fiber
  2. | Promise
  3. | Semaphore
  4. | Switch
  5. | Stream
  6. | 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_error : (id * exn) Runtime_events.User.t
val try_read : id 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
OCaml

Innovation. Community. Security.