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
  - S
  - Sub
- CCBool
- CCError
  - MONAD
  - Traverse
    
    M
- CCFloat
- CCFormat
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - COUNTER
  - DEFAULT
  - Make
    
    X
  - MakeCounter
    
    X
  - MakeDefault
    
    X
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCInt
- CCList
  - Assoc
  - Idx
  - MONAD
  - Ref
  - Set
  - Traverse
    
    M
  - Zipper
- CCMap
  - Make
    
    O
  - S
- CCOpt
- CCOrd
- CCPair
- CCPrint
  - MONAD_IO
  - MakeIO
    
    M
- CCRandom
- CCRef
- CCSet
  - Make
    
    O
  - S
- CCString
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Array
  - Format
  - List
  - Random
  - String
containers.bigarray
- CCBigstring
containers.data
- CCBV
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - S
- CCIntMap
- CCMixmap
  - Make
    
    X
  - ORD
  - S
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentArray
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- CCRingBuffer
  - Array
    
    Byte
    
    Make
    
    Elt
    
    S
  - Byte
  - Make
    
    Array
    
    X
  - MakeFromArray
    
    A
  - S
    
    Array
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
containers.io
- CCIO
  - File
containers.iter
- CCKList
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
containers.misc
- Containers_misc
containers.sexp
- CCSexp
  - Traverse
- CCSexpM
  - MONAD
  - MakeDecode
    
    M
- CCSexpStream
  - L
  - Lexer
  - ParseGen
  - Source
    
    Manual
containers.string
- Containers_string
containers.thread
- CCFuture
  - Infix
  - Timer
- CCLock
containers.unix
- CCUnix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Utils around Mutex

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 update : 'a t -> ('a -> 'a) -> unit

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

val mutex : _ t -> Mutex.t

Underlying mutex

val get : 'a t -> 'a

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