package containers-thread

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Semaphores

containers-thread
- Library containers-thread
  - CCBlockingQueue
  - CCLock
    
    LockRef
  - CCPool
    
    PARAM
    
    Make
    
    Fut
    
    Infix
  - CCSemaphore
  - CCThread
    
    Arr
    
    Barrier
  - CCTimer
- Sources
  - containers-thread
    
    CCBlockingQueue.ml
    
    CCLock.ml
    
    CCPool.ml
    
    CCSemaphore.ml
    
    CCThread.ml
    
    CCTimer.ml

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

Module `CCSemaphore`Source

Semaphores

since 0.13

Sourcetype t

A semaphore

Sourceval create : int -> t

create n creates a semaphore with initial value n.

raises Invalid_argument
if n <= 0.

Sourceval get : t -> int

Current value.

Sourceval acquire : int -> t -> unit

acquire n s blocks until get s >= n, then atomically sets s := !s - n.

Sourceval release : int -> t -> unit

release n s atomically sets s := !s + n.

Sourceval with_acquire : n:int -> t -> f:(unit -> 'a) -> 'a

with_acquire ~n s ~f first acquires s with n units, calls f (), and then releases s with n units. Safely release the semaphore even if f () fails.

Sourceval wait_until_at_least : n:int -> t -> f:(unit -> 'a) -> 'a

wait_until_at_least ~n s ~f waits until get s >= n, then calls f () and returns its result. Doesn't modify the semaphore.

package containers-thread

Module CCSemaphoreSource

Semaphores

Module `CCSemaphore`Source