mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-05 19:00:31 -05:00
152 lines
No EOL
9.1 KiB
HTML
152 lines
No EOL
9.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="CCThread.html">
|
|
<link rel="next" href="CCTimer.html">
|
|
<link rel="Up" href="index.html">
|
|
<link title="Index of types" rel=Appendix href="index_types.html">
|
|
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
|
|
<link title="Index of values" rel=Appendix href="index_values.html">
|
|
<link title="Index of class methods" rel=Appendix href="index_methods.html">
|
|
<link title="Index of class types" rel=Appendix href="index_class_types.html">
|
|
<link title="Index of modules" rel=Appendix href="index_modules.html">
|
|
<link title="Index of module types" rel=Appendix href="index_module_types.html">
|
|
<link title="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCArray_slice" rel="Chapter" href="CCArray_slice.html">
|
|
<link title="CCListLabels" rel="Chapter" href="CCListLabels.html">
|
|
<link title="CCArrayLabels" rel="Chapter" href="CCArrayLabels.html">
|
|
<link title="CCEqual" rel="Chapter" href="CCEqual.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="CCZipper" rel="Chapter" href="CCZipper.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexp_lex" rel="Chapter" href="CCSexp_lex.html"><title>Containers doc : CCBlockingQueue</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCThread.html" title="CCThread">Previous</a>
|
|
<a class="up" href="index.html" title="Index">Up</a>
|
|
<a class="post" href="CCTimer.html" title="CCTimer">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCBlockingQueue.html">CCBlockingQueue</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> CCBlockingQueue: <code class="code"><span class="keyword">sig</span></code> <a href="CCBlockingQueue.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
|
|
<h1 id="1_BlockingQueue">Blocking Queue</h1>
|
|
<p>
|
|
|
|
This queue has a limited size. Pushing a value on the queue when it
|
|
is full will block.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
|
|
<div class="info ">
|
|
Safe-thread queue for values of type <code class="code"><span class="keywordsign">'</span>a</code><br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">int -> 'a <a href="CCBlockingQueue.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Create a new queue of size <code class="code">n</code>. Using <code class="code">n=max_int</code> amounts to using
|
|
an infinite queue (2^61 items is a lot to fit in memory); using <code class="code">n=1</code>
|
|
amounts to using a box with 0 or 1 elements inside.<br>
|
|
<b>Raises</b> <code>Invalid_argument</code> if <code class="code">n < 1</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALpush"><span class="keyword">val</span> push</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a -> unit</code></pre><div class="info ">
|
|
<code class="code">push q x</code> pushes <code class="code">x</code> into <code class="code">q</code>, blocking if the queue is full<br>
|
|
</div>
|
|
|
|
<pre><span id="VALtake"><span class="keyword">val</span> take</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Take the first element, blocking if needed<br>
|
|
</div>
|
|
|
|
<pre><span id="VALpush_list"><span class="keyword">val</span> push_list</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a list -> unit</code></pre><div class="info ">
|
|
Push items of the list, one by one<br>
|
|
</div>
|
|
|
|
<pre><span id="VALtake_list"><span class="keyword">val</span> take_list</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> int -> 'a list</code></pre><div class="info ">
|
|
<code class="code">take_list n q</code> takes <code class="code">n</code> elements out of <code class="code">q</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALtry_take"><span class="keyword">val</span> try_take</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
|
|
Take the first element if the queue is not empty, return <code class="code"><span class="constructor">None</span></code>
|
|
otherwise<br>
|
|
</div>
|
|
|
|
<pre><span id="VALtry_push"><span class="keyword">val</span> try_push</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a -> bool</code></pre><div class="info ">
|
|
<code class="code">try_push q x</code> pushes <code class="code">x</code> into <code class="code">q</code> if <code class="code">q</code> is not full, in which
|
|
case it returns <code class="code"><span class="keyword">true</span></code>.
|
|
If it fails because <code class="code">q</code> is full, it returns <code class="code"><span class="keyword">false</span></code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
|
|
<code class="code">peek q</code> returns <code class="code"><span class="constructor">Some</span> x</code> if <code class="code">x</code> is the first element of <code class="code">q</code>,
|
|
otherwise it returns <code class="code"><span class="constructor">None</span></code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of elements currently in the queue<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcapacity"><span class="keyword">val</span> capacity</span> : <code class="type">'a <a href="CCBlockingQueue.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of values the queue can hold<br>
|
|
</div>
|
|
</body></html> |