package picos

You can search for identifiers within the package.

in-package search v0.2.0

package picos

picos
- Picos
  - Computation
  - Fiber
    
    FLS
    
    Maybe
  - Handler
  - Trigger
picos.domain
- Picos_domain
  - DLS
picos.exn_bt
- Picos_exn_bt
picos.fd
- Picos_fd
  - Resource
picos.fifos
- Picos_fifos
picos.htbl
- Picos_htbl
picos.lwt
- Picos_lwt
  - Make
    
    _
  - S
  - Sleep
picos.mpsc_queue
- Picos_mpsc_queue
picos.rc
- Picos_rc
  - Make
    
    Resource
  - Resource
  - S
    
    Resource
picos.select
- Picos_select
  - Intr
picos.stdio
- Picos_stdio
  - Unix
    
    LargeFile
picos.structured
- Picos_structured
  - Bundle
  - Control
  - Finally
  - Run
picos.sync
- Picos_sync
  - Condition
  - Lazy
  - Mutex
picos.thread
- Picos_thread
  - TLS
picos.threaded
- Picos_threaded

Legend:
Library
Module
Module type
Parameter
Class
Class type

A dynamic bundle of fibers guaranteed to be joined at the end.

type t

Represents a bundle of fibers.

val join_after : (t -> 'a) -> 'a

join_after scope calls scope with a bundle. A call of join_after returns or raises only after scope has returned or raised and all forked fibers have terminated. If scope raises an exception, error will be called.

ℹ️ When scope returns normally, terminate will not be called implicitly.

val terminate : ?callstack:int -> t -> unit

terminate bundle cancels all the forked fibers using the Terminate exception.

The optional callstack argument specifies the number of callstack entries to capture with the Terminate exception. The default is 0.

val error : t -> Picos.Exn_bt.t -> unit

error bundle exn_bt first calls terminate and then adds the exception with backtrace to the list of exceptions to be raised, unless the exception is the Terminate exception, which is not considered to signal an error by itself.

val fork : t -> (unit -> unit) -> unit

fork bundle action spawns a new fiber to the bundle that will run the given action. If the action raises an exception, error will be called with that exception.