package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

eio-1.5.tbz
sha256=7d70d1f5fb2b7190bf1ab28fffeb272da51ffe6d6c9c7c94e0485fabdf3b3fda
sha512=4582ac2fb2f8616b3d8ae9670eb7913a78085899b14044408801b30a34fed6c4d32971ba72eedb0cbc3d82c057610cf81c482090e75e2985330fcde96478ac5e

doc/eio.unix/Eio_unix/Private/Thread_pool/index.html

Module Private.Thread_poolSource

A pool of systhreads, to avoid the overhead of creating a new thread for each operation.

Sourcetype t
Sourceval create : sleep_q:Eio_utils.Zzz.t -> t

create ~sleep_q is a new thread pool.

sleep_q is used to register a clean-up task to finish idle threads.

Sourceval run : t -> (unit -> 'a) -> 'a

run t fn runs fn () and then marks t as closed, releasing all idle threads.

Sourceval submit : t -> ctx:Eio.Private.Fiber_context.t -> enqueue:(('a, Eio.Exn.with_bt) result -> unit) -> (unit -> 'a) -> unit

submit t ~ctx ~enqueue fn starts running fn in a sys-thread, which uses enqueue to return the result.

If ctx is already cancelled then the error is passed to enqueue immediately. Systhreads do not respond to cancellation once running.

Sourcetype Effect.t +=
  1. | Run_in_systhread : (unit -> 'a) -> (('a, Eio.Exn.with_bt) result * t) Effect.t
Sourceval run_in_systhread : ?label:string -> (unit -> 'a) -> 'a