package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Utils around Mutex

package containers

containers
- CCArray
  - MONO_ARRAY
- CCArrayLabels
  - MONO_ARRAY
- CCArray_slice
- CCBool
- CCChar
- CCEqual
  - Infix
- CCFloat
  - Infix
- CCFormat
  - Dump
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
    
    X
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCIO
  - File
- CCInt
  - Infix
- CCInt64
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
    
    O
  - S
- CCOpt
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Infix
  - U
- CCRandom
  - State
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
    
    O
  - S
- CCString
  - Find
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.data
- CCBV
- CCBitField
  - Make
    
    X
  - S
- CCCache
- CCDeque
- CCFQueue
- CCGraph
  - Dot
  - Lazy_tree
  - MAP
  - Map
    
    O
  - Seq
  - Traverse
    
    Event
- CCHashSet
  - ELEMENT
  - Make
    
    E
  - S
- CCHashTrie
  - KEY
  - Make
    
    K
  - S
  - Transient
- CCHet
  - Key
  - Map
  - Tbl
- CCImmutArray
- CCIntMap
- CCMixmap
  - Make
    
    X
  - ORD
  - S
- CCMixset
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentArray
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- CCRAL
  - Infix
- CCRingBuffer
  - Array
    
    Byte
    
    Make
    
    Elt
    
    S
  - Byte
  - Make
    
    Array
    
    X
  - MakeFromArray
    
    A
  - S
    
    Array
- CCSimple_queue
  - Infix
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
- CCWBTree
  - KEY
  - Make
    
    X
  - MakeFull
    
    X
  - ORD
  - S
- CCZipper
containers.iter
- CCKList
  - Infix
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
- CCLazy_list
  - Infix
containers.monomorphic
- CCMonomorphic
containers.sexp
- CCSexp
  - Decoder
- CCSexp_lex
containers.thread
- CCBlockingQueue
- CCLock
  - LockRef
- CCPool
  - Make
    
    Fut
    
    Infix
    
    P
  - PARAM
- CCSemaphore
- CCThread
  - Arr
  - Barrier
- CCTimer
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Utils around Mutex

A value wrapped into a Mutex, for more safety.

since 0.8

type 'a t

A value surrounded with a lock

val create : 'a -> 'a t

Create a new protected value.

val with_lock : 'a t -> ('a -> 'b) -> 'b

with_lock l f runs f x where x is the value protected with the lock l, in a critical section. If f x fails, with_lock l f fails too but the lock is released.

val try_with_lock : 'a t -> ('a -> 'b) -> 'b option

try_with_lock l f runs f x in a critical section if l is not locked. x is the value protected by the lock l. If f x fails, try_with_lock l f fails too but the lock is released.

since 0.22

module LockRef : sig ... end

Type allowing to manipulate the lock as a reference

val with_lock_as_ref : 'a t -> f:('a LockRef.t -> 'b) -> 'b

with_lock_as_ref l f calls f with a reference-like object that allows to manipulate the value of l safely. The object passed to f must not escape the function call.

since 0.13

val update : 'a t -> ('a -> 'a) -> unit

update l f replaces the content x of l with f x, atomically.

val update_map : 'a t -> ('a -> 'a * 'b) -> 'b

update_map l f computes x', y = f (get l), then puts x' in l and returns y.

since 0.16

val mutex : _ t -> Mutex.t

Underlying mutex.

val get : 'a t -> 'a

Atomically get the value in the lock. The value that is returned isn't protected!

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

Atomically set the value.

since 0.13

val incr : int t -> unit

Atomically increment the value.

since 0.13

val decr : int t -> unit

Atomically decrement the value.

since 0.13

val incr_then_get : int t -> int

incr_then_get x increments x, and returns its new value.

since 0.16

val get_then_incr : int t -> int

get_then_incr x increments x, and returns its previous value.

since 0.16

val decr_then_get : int t -> int

decr_then_get x decrements x, and returns its new value.

since 0.16

val get_then_decr : int t -> int

get_then_decr x decrements x, and returns its previous value.

since 0.16

val get_then_set : bool t -> bool

get_then_set b sets b to true, and returns the old value.

since 0.16

val get_then_clear : bool t -> bool

get_then_clear b sets b to false, and returns the old value.

since 0.16