<!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=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="Ringbuffer.Elt.html"> <link rel="Up" href="Ringbuffer.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 classes" rel=Appendix href="index_classes.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="Audio" rel="Chapter" href="Audio.html"> <link title="Image" rel="Chapter" href="Image.html"> <link title="MIDI" rel="Chapter" href="MIDI.html"> <link title="Ringbuffer" rel="Chapter" href="Ringbuffer.html"> <link title="Synth" rel="Chapter" href="Synth.html"> <link title="Video" rel="Chapter" href="Video.html"><title>Ringbuffer.R</title> </head> <body> <div class="navbar"><a class="pre" href="Ringbuffer.Elt.html" title="Ringbuffer.Elt">Previous</a> <a class="up" href="Ringbuffer.html" title="Ringbuffer">Up</a> </div> <h1>Module type <a href="type_Ringbuffer.R.html">Ringbuffer.R</a></h1> <pre><span class="keyword">module type</span> R = <code class="code">sig</code> <a href="Ringbuffer.R.html">..</a> <code class="code">end</code></pre><div class="info modtype top"> Signature for ringbuffer modules.<br> </div> <hr width="100%"> <pre><span id="TYPEelt"><span class="keyword">type</span> <code class="type"></code>elt</span> </pre> <div class="info "> Type of elements contained in the ringbuffer.<br> </div> <pre><span id="TYPEbuffer"><span class="keyword">type</span> <code class="type"></code>buffer</span> = <code class="type"><a href="Ringbuffer.R.html#TYPEelt">elt</a> array</code> </pre> <div class="info "> A buffer of elements.<br> </div> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre> <div class="info "> A ringbuffer.<br> </div> <pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">int -> <a href="Ringbuffer.R.html#TYPEt">t</a></code></pre><div class="info "> Create a ringbuffer of given size.<br> </div> <pre><span id="VALread_space"><span class="keyword">val</span> read_space</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> int</code></pre><div class="info "> Size of data available for reading.<br> </div> <pre><span id="VALwrite_space"><span class="keyword">val</span> write_space</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> int</code></pre><div class="info "> Size of space available for writing.<br> </div> <pre><span id="VALread_advance"><span class="keyword">val</span> read_advance</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> int -> unit</code></pre><div class="info "> Drop data.<br> </div> <pre><span id="VALwrite_advance"><span class="keyword">val</span> write_advance</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> int -> unit</code></pre><div class="info "> Advance the write pointer.<br> </div> <pre><span id="VALread"><span class="keyword">val</span> read</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> <a href="Ringbuffer.R.html#TYPEbuffer">buffer</a> -> int -> int -> unit</code></pre><div class="info "> Read data.<br> </div> <pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> <a href="Ringbuffer.R.html#TYPEbuffer">buffer</a> -> int -> int -> unit</code></pre><div class="info "> Same as <code class="code">read</code> but does not advance the read pointer.<br> </div> <pre><span id="VALwrite"><span class="keyword">val</span> write</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> <a href="Ringbuffer.R.html#TYPEbuffer">buffer</a> -> int -> int -> unit</code></pre><div class="info "> Write data.<br> </div> <pre><span id="VALtransmit"><span class="keyword">val</span> transmit</span> : <code class="type"><a href="Ringbuffer.R.html#TYPEt">t</a> -> (<a href="Ringbuffer.R.html#TYPEbuffer">buffer</a> -> int -> int -> int) -> int</code></pre><div class="info "> Read all the data in the ringbuffer.<br> </div> </body></html>
