<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Jack2: ringbuffer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Jack2
 <span id="projectnumber">1.9.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_53ce5aad08e69f28222d538bfd477ab2.html">jack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ringbuffer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ringbuffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2000 Paul Davis</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2003 Rohan Drape</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> </span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This program is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> the Free Software Foundation; either version 2.1 of the License, or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> GNU Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> along with this program; if not, write to the Free Software </span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef _RINGBUFFER_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define _RINGBUFFER_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <sys/types.h></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="structjack__ringbuffer__data__t.html"> 45</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">char</span> *buf;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">size_t</span> len;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <a class="code" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> ;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="structjack__ringbuffer__t.html"> 51</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">char</span> *buf;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">volatile</span> <span class="keywordtype">size_t</span> write_ptr;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">volatile</span> <span class="keywordtype">size_t</span> read_ptr;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">size_t</span> size;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">size_t</span> size_mask;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> mlocked;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> ;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *<a class="code" href="ringbuffer_8h.html#a11f9045eb4b0561b26ec434c44e3c922">jack_ringbuffer_create</a>(<span class="keywordtype">size_t</span> sz);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#aa82de39e73e06aa729e092710b83ef61">jack_ringbuffer_free</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#aa21aaf8ff173ba0e89b35554f20d4ccb">jack_ringbuffer_get_read_vector</a>(<span class="keyword">const</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb,</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> *vec);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#a1c44a50c99f43bb683d8721f14aefc7d">jack_ringbuffer_get_write_vector</a>(<span class="keyword">const</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb,</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> *vec);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">size_t</span> <a class="code" href="ringbuffer_8h.html#a4b001e5844a116a1d51006e2716c73bb">jack_ringbuffer_read</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <span class="keywordtype">char</span> *dest, <span class="keywordtype">size_t</span> cnt);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">size_t</span> <a class="code" href="ringbuffer_8h.html#ad268f29e641b39bee8155e7e80ad4520">jack_ringbuffer_peek</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <span class="keywordtype">char</span> *dest, <span class="keywordtype">size_t</span> cnt);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#aa9cdd4b69ae338c6ce464a1de00ee71a">jack_ringbuffer_read_advance</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <span class="keywordtype">size_t</span> cnt);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="keywordtype">size_t</span> <a class="code" href="ringbuffer_8h.html#a61e93fa7c9bfb6897dd2508d026d9317">jack_ringbuffer_read_space</a>(<span class="keyword">const</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb);</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="keywordtype">int</span> <a class="code" href="ringbuffer_8h.html#aeb059ff23c65389d48ebbe948f05c2b2">jack_ringbuffer_mlock</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#a40244c7eee331822cd99132a14e76896">jack_ringbuffer_reset</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#abd4df94d0a2b2ae8bdb98ca1d904402b">jack_ringbuffer_reset_size</a> (<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * rb, <span class="keywordtype">size_t</span> sz);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="keywordtype">size_t</span> <a class="code" href="ringbuffer_8h.html#a6d2fc75510e4df62f5b3dd249047b132">jack_ringbuffer_write</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <span class="keyword">const</span> <span class="keywordtype">char</span> *src,</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">size_t</span> cnt);</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keywordtype">void</span> <a class="code" href="ringbuffer_8h.html#a7255e067e485770d8127d821b6d7e9ec">jack_ringbuffer_write_advance</a>(<a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <span class="keywordtype">size_t</span> cnt);</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="keywordtype">size_t</span> <a class="code" href="ringbuffer_8h.html#a07a5f6086380300b7b2ccfd7cf9c2ef6">jack_ringbuffer_write_space</a>(<span class="keyword">const</span> <a class="code" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb);</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.8.1.1</small></address>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
136c306a350f6a4bd3abd3af7df09a32
>
files
>
91
