mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
4.4 KiB
HTML
2 lines
No EOL
4.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCSemaphore (containers-thread.CCSemaphore)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">containers-thread</a> » CCSemaphore</nav><header class="odoc-preamble"><h1>Module <code><span>CCSemaphore</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#semaphores">Semaphores</a></li></ul></nav><div class="odoc-content"><h2 id="semaphores"><a href="#semaphores" class="anchor"></a>Semaphores</h2><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.13</li></ul><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>A semaphore</p></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create n</code> creates a semaphore with initial value <code>n</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Invalid_argument</span> <p>if <code>n <= 0</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-get" class="anchored"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Current value.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-acquire" class="anchored"><a href="#val-acquire" class="anchor"></a><code><span><span class="keyword">val</span> acquire : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>acquire n s</code> blocks until <code>get s >= n</code>, then atomically sets <code>s := !s - n</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-release" class="anchored"><a href="#val-release" class="anchor"></a><code><span><span class="keyword">val</span> release : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>release n s</code> atomically sets <code>s := !s + n</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_acquire" class="anchored"><a href="#val-with_acquire" class="anchor"></a><code><span><span class="keyword">val</span> with_acquire : <span>n:int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>f:<span>( <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span> )</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_acquire ~n s ~f</code> first acquires <code>s</code> with <code>n</code> units, calls <code>f ()</code>, and then releases <code>s</code> with <code>n</code> units. Safely release the semaphore even if <code>f ()</code> fails.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-wait_until_at_least" class="anchored"><a href="#val-wait_until_at_least" class="anchor"></a><code><span><span class="keyword">val</span> wait_until_at_least : <span>n:int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>f:<span>( <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span> )</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>wait_until_at_least ~n s ~f</code> waits until <code>get s >= n</code>, then calls <code>f ()</code> and returns its result. Doesn't modify the semaphore.</p></div></div></div></body></html> |