Module Picos.Handler

Handler for the effects based operations of Picos for OCaml 4.

type 'c t = {
  1. current : 'c -> Fiber.t;
    (*

    See Picos.Fiber.current.

    *)
  2. spawn : 'c -> Fiber.t -> (Fiber.t -> unit) -> unit;
    (*

    See Picos.Fiber.spawn.

    *)
  3. yield : 'c -> unit;
    (*

    See Picos.Fiber.yield.

    *)
  4. cancel_after : 'a. 'c -> 'a Computation.t -> seconds:float -> exn -> Stdlib.Printexc.raw_backtrace -> unit;
    (*

    See Picos.Computation.cancel_after.

    *)
  5. await : 'c -> Trigger.t -> (exn * Stdlib.Printexc.raw_backtrace) option;
    (*

    See Picos.Trigger.await.

    *)
}

A record of implementations of the primitive effects based operations of Picos. The operations take a context of type 'c as an argument.

val using : 'c t -> 'c -> (Fiber.t -> unit) -> unit

using handler context main sets the handler and the context for the handler of the primitive effects based operations of Picos while running main.

ℹ️ The behavior is that

  • on OCaml 4, using stores the handler in TLS, which allows the operations to be accessed during the execution of the thunk, and
  • on OCaml 5, using runs thunk with a deep effect handler that delegates to the operations of the handler.

⚠️ While this works on OCaml 5, you usually want to use a scheduler that implements an effect handler directly, because that is likely to perform better.