package picos_std

You can search for identifiers within the package.

in-package search v0.2.0

Sample libraries for Picos
- Library picos_std.event
  - Picos_std_event
    
    Event
- Library picos_std.finally
  - Picos_std_finally
- Library picos_std.structured
  - Picos_std_structured
    
    Control
    
    Promise
    
    Bundle
    
    Flock
    
    Run
- Library picos_std.sync
  - Picos_std_sync
    
    Mutex
    
    Condition
    
    Semaphore
    
    Counting
    
    Binary
    
    Lazy
    
    Latch
    
    Ivar
    
    Stream
- Sources
  - picos_std.event
    
    event.ml
    
    picos_std_event.ml
    
    picos_std_event__.ml
  - picos_std.finally
    
    picos_std_finally.ml
  - picos_std.structured
    
    bundle.ml
    
    control.ml
    
    flock.ml
    
    picos_std_structured.ml
    
    picos_std_structured__.ml
    
    promise.ml
    
    run.ml
  - picos_std.sync
    
    condition.ml
    
    ivar.ml
    
    latch.ml
    
    lazy.ml
    
    list_ext.ml
    
    mutex.ml
    
    picos_std_sync.ml
    
    picos_std_sync__.ml
    
    q.ml
    
    semaphore.ml
    
    stream.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Picos_std_sync.Latch`Source

A dynamic single-use countdown latch.

Latches are typically used for determining when a finite set of parallel computations is done. If the size of the set is known a priori, then the latch can be initialized with the size as initial count and then each computation just decrements the latch.

If the size is unknown, i.e. it is determined dynamically, then a latch is initialized with a count of one, the a priori known computations are started and then the latch is decremented. When a computation is stsrted, the latch is incremented, and then decremented once the computation has finished.

Sourcetype t

Represents a dynamic countdown latch.

Sourceval create : ?padded:bool -> int -> t

create initial creates a new countdown latch with the specified initial count.

raises Invalid_argument
in case the specified initial count is negative.

Sourceval try_decr : t -> bool

try_decr latch attempts to decrement the count of the latch and returns true in case the count of the latch was greater than zero and false in case the count already was zero.

Sourceval decr : t -> unit

decr latch is equivalent to:

  if not (try_decr latch) then
    invalid_arg "zero count"

raises Invalid_argument
in case the count of the latch is zero.

Sourceval try_incr : t -> bool

try_incr latch attempts to increment the count of the latch and returns true on success and false on failure, which means that the latch has already reached zero.

Sourceval incr : t -> unit

incr latch is equivalent to:

  if not (try_incr latch) then
    invalid_arg "zero count"

raises Invalid_argument
in case the count of the latch is zero.

Sourceval await : t -> unit

await latch returns after the count of the latch has reached zero.

Sourceval await_evt : t -> unit Picos_std_event.Event.t

await_evt latch returns an event that can be committed to once the count of the latch has reached zero.

package picos_std

Module Picos_std_sync.LatchSource

Module `Picos_std_sync.Latch`Source