package eio

You can search for identifiers within the package.

in-package search v0.2.0

Effect-based direct-style IO API for OCaml

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (18)

Authors

Maintainers

A

anil@recoil.org

Sources

eio-0.13.tbz

sha256=82537ee1c5b1829fde8207614a4e39f560bd582332841290ed5ef76691f3af70

sha512=69fc509e5ed34da64c3c26fa22558ce7f0cb42afa65c864c57dbb05948e12c0f4f6ab7b77a07f8b292ea3a18748ed46deb9da6af74852115da5e938177b3bf18

doc/eio.runtime_events/Eio_runtime_events/index.html

Module `Eio_runtime_events`Source

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

Sourcetype id = int

Sourcetype ty =

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

Sourceval ty_to_string : ty -> string

Writing events

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

Sourceval log : string Runtime_events.User.t

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

Sourceval resolve : id Runtime_events.User.t

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

Sourceval fiber : id Runtime_events.User.t

Sourceval read : id Runtime_events.User.t

Sourceval try_read : id Runtime_events.User.t

Sourceval signal : id Runtime_events.User.t

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

Consuming events

Sourcetype '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.

Source

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

On This Page

Writing events
Consuming events