package picos

You can search for identifiers within the package.

in-package search v0.2.0

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

Basic control operations and exceptions for structured concurrency.

exception Terminate

An exception that is used to signal fibers, typically by canceling them, that they should terminate by letting the exception propagate. This does not, by itself, indicate an error.

exception Errors of Picos.Exn_bt.t list

An exception that can be used to collect exceptions, typically indicating errors, from multiple fibers.

val raise_if_canceled : unit -> unit

raise_if_canceled () checks whether the current fiber has been canceled and if so raises the exception that the fiber was canceled with.

val yield : unit -> unit

yield () asks the current fiber to be rescheduled.

val sleep : seconds:float -> unit

sleep ~seconds suspends the current fiber for specified number of seconds.

val protect : (unit -> 'a) -> 'a

protect thunk forbids cancelation for the duration of thunk ().

val block : unit -> 'a

block () suspends the current fiber until it is canceled at which point the cancelation exception will be raised.

⚠️ Beware that protect block never returns and you don't want that.