package picos

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

API
1. Interface for producers
2. Interface for the owner / consumer
Examples

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
  - System
picos.lwt_unix
- Picos_lwt_unix
picos.mpscq
- Picos_mpscq
picos.randos
- Picos_randos
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
  - Promise
  - 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

Lock-free multi-producer, single-consumer queue.

🏎️ This data structure is optimized for use as a non-work-stealing scheduler's ready queue.

API

type !'a t

A multi-producer, single-consumer queue.

val create : unit -> 'a t

create () returns a new empty multi-producer, single-consumer queue.

Interface for producers

ℹ️ The operations in this section can be called by both any number of producers and the single owner / consumer of the queue.

val push : 'a t -> 'a -> unit

push queue value adds the value to the tail of the queue.

val push_head : 'a t -> 'a -> unit

push_head queue value adds the value to the head of the queue.

Interface for the owner / consumer

⚠️ The operations in this section should only be called by the single owner / consumer of the queue.

exception Empty

Raised by pop_exn in case it finds the queue empty.

val pop_exn : 'a t -> 'a

pop_exn queue tries to remove the value at the head of the queue. Returns the removed value or raises Empty in case the queue was empty.

raises Empty
in case the queue was empty.

val pop_all : 'a t -> 'a Stdlib.Seq.t

pop_all queue removes all values from the queue and returns them as a sequence.

Examples

An example top-level session:

# let q : int Picos_mpscq.t =
    Picos_mpscq.create ()
val q : int Picos_mpscq.t = <abstr>

# Picos_mpscq.push q 42
- : unit = ()

# Picos_mpscq.push_head q 76
- : unit = ()

# Picos_mpscq.push q 101
- : unit = ()

# Picos_mpscq.pop_exn q
- : int = 76

# Picos_mpscq.pop_all q |> List.of_seq
- : int list = [42; 101]