<!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"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: buffer.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">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</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_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_6b3e09e31d3da6038137f0238e9fb19b.html">cc++</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">buffer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="buffer_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">// Copyright (C) 1999-2005 Open Source Telecom Corporation.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// This program is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (at your option) any later version.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// GNU General Public License for more details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// along with this program; if not, write to the Free Software</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// As a special exception, you may use this file as part of a free software</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// library without restriction. Specifically, if other files instantiate</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// templates or use macros or inline functions from this file, or you compile</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// this file and link it with other files to produce an executable, this</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// file does not by itself cause the resulting executable to be covered by</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// the GNU General Public License. This exception does not however</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// invalidate any other reasons why the executable file might be covered by</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// the GNU General Public License.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">//</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// This exception applies only to the code released under the name GNU</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Common C++. If you copy code from other releases into a copy of GNU</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Common C++, as the General Public License permits, the exception does</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// not apply to the code that you add in this way. To avoid misleading</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// anyone as to the status of such modified files, you must delete</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// this exception notice from them.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">//</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// If you write modifications of your own for GNU Common C++, it is your choice</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// whether to permit this exception to apply to your modifications.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// If you do not wish that, delete this exception notice.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifndef CCXX_BUFFER_H_</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span><span class="preprocessor">#define CCXX_BUFFER_H_</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#ifndef CCXX_THREAD_H_</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="thread_8h.html">cc++/thread.h</a>></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef CCXX_STRING_H_</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="string_8h.html">cc++/string.h</a>></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span><span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span><span class="keyword">namespace </span>ost {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#ifdef WIN32</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span><span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> Buffer : <span class="keyword">public</span> Mutex</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html"> 81</a></span> <span class="preprocessor"></span>class <a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_buffer.html">Buffer</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_conditional.html">Conditional</a></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span>{</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#ifdef WIN32</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span> <a class="code" href="serial_8h.html#a069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a> sem_head, sem_tail;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span> <span class="keywordtype">size_t</span> _size;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">size_t</span> _used;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> onPeek(<span class="keywordtype">void</span> *buf) = 0;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> onWait(<span class="keywordtype">void</span> *buf) = 0;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> onPost(<span class="keywordtype">void</span> *buf) = 0;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98"> 118</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">timeout</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classost_1_1_buffer.html">Buffer</a>(<span class="keywordtype">size_t</span> capacity);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_buffer.html">Buffer</a>();</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47"> 135</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47">getSize</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  {<span class="keywordflow">return</span> _size;};</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#a462525b42df6660894ccf8141d73071e"> 144</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classost_1_1_buffer.html#a462525b42df6660894ccf8141d73071e">getUsed</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  {<span class="keywordflow">return</span> _used;};</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">size_t</span> <a class="code" href="namespaceost.html#a24c7774639b3768bdd45b65a296f6369">wait</a>(<span class="keywordtype">void</span> *buf, <a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout = 0);</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">size_t</span> post(<span class="keywordtype">void</span> *buf, <a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout = 0);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">size_t</span> peek(<span class="keywordtype">void</span> *buf);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isValid(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> };</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="classost_1_1_fixed_buffer.html"> 190</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_buffer.html">Buffer</a></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> {</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">char</span> *buf, *head, *tail;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">size_t</span> objsize;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">size_t</span> onPeek(<span class="keywordtype">void</span> *buf);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">size_t</span> onWait(<span class="keywordtype">void</span> *buf);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordtype">size_t</span> onPost(<span class="keywordtype">void</span> *buf);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a>(<span class="keywordtype">size_t</span> capacity, <span class="keywordtype">size_t</span> objsize);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a>(<span class="keyword">const</span> <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> &fb);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a>();</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> &operator=(<span class="keyword">const</span> <a class="code" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> &fb);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">bool</span> isValid(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> };</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a name="l00261"></a><span class="lineno"><a class="line" href="classost_1_1_thread_queue.html"> 261</a></span> <span class="keyword">class </span><a class="code" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="classost_1_1_thread_queue.html">ThreadQueue</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_mutex.html">Mutex</a>, <span class="keyword">public</span> <a class="code" href="classost_1_1_thread.html">Thread</a>, <span class="keyword">public</span> <a class="code" href="classost_1_1_semaphore.html">Semaphore</a></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> {</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordtype">void</span> run(<span class="keywordtype">void</span>); <span class="comment">// private run method</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00267"></a><span class="lineno"><a class="line" href="structost_1_1_thread_queue_1_1__data.html"> 267</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structost_1_1_thread_queue_1_1__data.html">_data</a> {</div>
<div class="line"><a name="l00268"></a><span class="lineno"><a class="line" href="structost_1_1_thread_queue_1_1__data.html#a1724d1b8c31d42ce736f9d78c84b164e"> 268</a></span>  <span class="keyword">struct </span><a class="code" href="structost_1_1_thread_queue_1_1__data.html">_data</a> *<a class="code" href="structost_1_1_thread_queue_1_1__data.html#a1724d1b8c31d42ce736f9d78c84b164e">next</a>;</div>
<div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="structost_1_1_thread_queue_1_1__data.html#a8bbe2793f83a27746e7411145447a9dc"> 269</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structost_1_1_thread_queue_1_1__data.html#a8bbe2793f83a27746e7411145447a9dc">len</a>;</div>
<div class="line"><a name="l00270"></a><span class="lineno"><a class="line" href="structost_1_1_thread_queue_1_1__data.html#a5ef8d0b38df3dbef9dc8b22d13caf724"> 270</a></span>  <span class="keywordtype">char</span> data[1];</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  } <a class="code" href="structost_1_1_thread_queue_1_1__data.html">data_t</a>;</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div>
<div class="line"><a name="l00273"></a><span class="lineno"><a class="line" href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202"> 273</a></span>  <a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="code" href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202">timeout</a>;</div>
<div class="line"><a name="l00274"></a><span class="lineno"><a class="line" href="classost_1_1_thread_queue.html#a3202a4e136cd5e9b257b393a9984f3cd"> 274</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classost_1_1_thread_queue.html#a3202a4e136cd5e9b257b393a9984f3cd">started</a>;</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div>
<div class="line"><a name="l00276"></a><span class="lineno"><a class="line" href="classost_1_1_thread_queue.html#a5d34d11fd2535869d62c2c505e35f0a4"> 276</a></span>  <a class="code" href="structost_1_1_thread_queue_1_1__data.html">data_t</a> *first, *<a class="code" href="classost_1_1_thread_queue.html#a5d34d11fd2535869d62c2c505e35f0a4">last</a>; <span class="comment">// head/tail of list</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div>
<div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="classost_1_1_thread_queue.html#a1737937abcd8b410758d47d18b651e40"> 278</a></span>  <a class="code" href="classost_1_1_string.html">String</a> <a class="code" href="classost_1_1_thread_queue.html#a1737937abcd8b410758d47d18b651e40">name</a>;</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * Overloading of final(). It demarks Semaphore to avoid deadlock.</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <span class="keyword">final</span>();</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> </div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> startQueue(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> stopQueue(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> onTimer(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> runQueue(<span class="keywordtype">void</span> *data) = 0;</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <a class="code" href="classost_1_1_thread_queue.html">ThreadQueue</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>, <span class="keywordtype">int</span> pri, <span class="keywordtype">size_t</span> stack = 0);</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <span class="keyword">virtual</span> ~<a class="code" href="classost_1_1_thread_queue.html">ThreadQueue</a>();</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> </div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keywordtype">void</span> setTimer(<a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout);</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> </div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keywordtype">void</span> post(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">unsigned</span> len);</div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> };</div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> </div>
<div class="line"><a name="l00350"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#abe2397b9087bd1651ee67ed5702c01dd"> 350</a></span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <span class="keyword">get</span>(<a class="code" href="classost_1_1_buffer.html">Buffer</a> &b, <span class="keywordtype">void</span> *o, <a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t = 0)</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  {<span class="keywordflow">return</span> b.wait(o, t);}</div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> </div>
<div class="line"><a name="l00354"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#a1dc4ad52b6f17817e4afa981d1db6fae"> 354</a></span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classost_1_1_buffer.html#a1dc4ad52b6f17817e4afa981d1db6fae">put</a>(<a class="code" href="classost_1_1_buffer.html">Buffer</a> &b, <span class="keywordtype">void</span> *o, <a class="code" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t = 0)</div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  {<span class="keywordflow">return</span> b.<a class="code" href="classost_1_1_buffer.html#a9d106bd44d9bee8d9ef049cfa264e5b7">post</a>(o, t);}</div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> </div>
<div class="line"><a name="l00358"></a><span class="lineno"><a class="line" href="classost_1_1_buffer.html#a2066fdf67ab3b6727be90a51fc5c4d64"> 358</a></span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classost_1_1_buffer.html#a2066fdf67ab3b6727be90a51fc5c4d64">peek</a>(<a class="code" href="classost_1_1_buffer.html">Buffer</a> &b, <span class="keywordtype">void</span> *o)</div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  {<span class="keywordflow">return</span> b.<a class="code" href="classost_1_1_buffer.html#ae613b6a13146b782ce5749b810cceba8">peek</a>(o);}</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> </div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor"></span></div>
<div class="ttc" id="classost_1_1_string_html"><div class="ttname"><a href="classost_1_1_string.html">ost::String</a></div><div class="ttdoc">This is a generic and portable string class. </div><div class="ttdef"><b>Definition:</b> string.h:77</div></div>
<div class="ttc" id="string_8h_html"><div class="ttname"><a href="string_8h.html">string.h</a></div><div class="ttdoc">Common C++ generic string class. </div></div>
<div class="ttc" id="serial_8h_html_a069bb8cb95b0528d5ce0304bb5561a40"><div class="ttname"><a href="serial_8h.html#a069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a></div><div class="ttdeci">int HANDLE</div><div class="ttdef"><b>Definition:</b> serial.h:60</div></div>
<div class="ttc" id="structost_1_1_thread_queue_1_1__data_html_a1724d1b8c31d42ce736f9d78c84b164e"><div class="ttname"><a href="structost_1_1_thread_queue_1_1__data.html#a1724d1b8c31d42ce736f9d78c84b164e">ost::ThreadQueue::_data::next</a></div><div class="ttdeci">struct _data * next</div><div class="ttdef"><b>Definition:</b> buffer.h:268</div></div>
<div class="ttc" id="classost_1_1_buffer_html_ae416c78e4d5dc50bfa3c4e0b98fd7a98"><div class="ttname"><a href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">ost::Buffer::timeout</a></div><div class="ttdeci">static const size_t timeout</div><div class="ttdoc">value to return when a timed operation returned with a timeout. </div><div class="ttdef"><b>Definition:</b> buffer.h:118</div></div>
<div class="ttc" id="namespaceost_html_a24c7774639b3768bdd45b65a296f6369"><div class="ttname"><a href="namespaceost.html#a24c7774639b3768bdd45b65a296f6369">ost::wait</a></div><div class="ttdeci">void wait(signo_t signo)</div></div>
<div class="ttc" id="config_8h_html_ad10ef148ba8327bd530fc6c32c1e181c"><div class="ttname"><a href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a></div><div class="ttdeci">#define __EXPORT</div><div class="ttdef"><b>Definition:</b> config.h:980</div></div>
<div class="ttc" id="structost_1_1_thread_queue_1_1__data_html"><div class="ttname"><a href="structost_1_1_thread_queue_1_1__data.html">ost::ThreadQueue::_data</a></div><div class="ttdef"><b>Definition:</b> buffer.h:267</div></div>
<div class="ttc" id="classost_1_1_thread_queue_html_a3202a4e136cd5e9b257b393a9984f3cd"><div class="ttname"><a href="classost_1_1_thread_queue.html#a3202a4e136cd5e9b257b393a9984f3cd">ost::ThreadQueue::started</a></div><div class="ttdeci">bool started</div><div class="ttdef"><b>Definition:</b> buffer.h:274</div></div>
<div class="ttc" id="classost_1_1_buffer_html_a462525b42df6660894ccf8141d73071e"><div class="ttname"><a href="classost_1_1_buffer.html#a462525b42df6660894ccf8141d73071e">ost::Buffer::getUsed</a></div><div class="ttdeci">size_t getUsed(void)</div><div class="ttdoc">Return the current capacity in use for the buffer. </div><div class="ttdef"><b>Definition:</b> buffer.h:144</div></div>
<div class="ttc" id="thread_8h_html_af412159e5cef839836a5e7b19ee75d1c"><div class="ttname"><a href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a></div><div class="ttdeci">unsigned long timeout_t</div><div class="ttdef"><b>Definition:</b> thread.h:74</div></div>
<div class="ttc" id="thread_8h_html"><div class="ttname"><a href="thread_8h.html">thread.h</a></div><div class="ttdoc">Synchronization and threading services. </div></div>
<div class="ttc" id="classost_1_1_buffer_html"><div class="ttname"><a href="classost_1_1_buffer.html">ost::Buffer</a></div><div class="ttdoc">The buffer class represents an IPC service that is built upon a buffer of fixed capacity that can be ...</div><div class="ttdef"><b>Definition:</b> buffer.h:81</div></div>
<div class="ttc" id="classost_1_1_buffer_html_a1dc4ad52b6f17817e4afa981d1db6fae"><div class="ttname"><a href="classost_1_1_buffer.html#a1dc4ad52b6f17817e4afa981d1db6fae">ost::Buffer::put</a></div><div class="ttdeci">size_t put(Buffer &b, void *o, timeout_t t=0)</div><div class="ttdef"><b>Definition:</b> buffer.h:354</div></div>
<div class="ttc" id="classost_1_1_thread_queue_html_a5d34d11fd2535869d62c2c505e35f0a4"><div class="ttname"><a href="classost_1_1_thread_queue.html#a5d34d11fd2535869d62c2c505e35f0a4">ost::ThreadQueue::last</a></div><div class="ttdeci">data_t * last</div><div class="ttdef"><b>Definition:</b> buffer.h:276</div></div>
<div class="ttc" id="classost_1_1_conditional_html"><div class="ttname"><a href="classost_1_1_conditional.html">ost::Conditional</a></div><div class="ttdoc">A conditional variable synchcronization object for one to one and one to many signal and control even...</div><div class="ttdef"><b>Definition:</b> thread.h:636</div></div>
<div class="ttc" id="classost_1_1_buffer_html_aedd8b294e02c08a60bde023bd2c1ff47"><div class="ttname"><a href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47">ost::Buffer::getSize</a></div><div class="ttdeci">size_t getSize(void)</div><div class="ttdoc">Return the capacity of the buffer as specified at creation. </div><div class="ttdef"><b>Definition:</b> buffer.h:135</div></div>
<div class="ttc" id="classost_1_1_buffer_html_ae613b6a13146b782ce5749b810cceba8"><div class="ttname"><a href="classost_1_1_buffer.html#ae613b6a13146b782ce5749b810cceba8">ost::Buffer::peek</a></div><div class="ttdeci">size_t peek(void *buf)</div><div class="ttdoc">Peek at the current content (first object) in the buffer. </div></div>
<div class="ttc" id="structost_1_1_thread_queue_1_1__data_html_a8bbe2793f83a27746e7411145447a9dc"><div class="ttname"><a href="structost_1_1_thread_queue_1_1__data.html#a8bbe2793f83a27746e7411145447a9dc">ost::ThreadQueue::_data::len</a></div><div class="ttdeci">unsigned len</div><div class="ttdef"><b>Definition:</b> buffer.h:269</div></div>
<div class="ttc" id="classost_1_1_buffer_html_a2066fdf67ab3b6727be90a51fc5c4d64"><div class="ttname"><a href="classost_1_1_buffer.html#a2066fdf67ab3b6727be90a51fc5c4d64">ost::Buffer::peek</a></div><div class="ttdeci">size_t peek(Buffer &b, void *o)</div><div class="ttdef"><b>Definition:</b> buffer.h:358</div></div>
<div class="ttc" id="classost_1_1_thread_queue_html_a1737937abcd8b410758d47d18b651e40"><div class="ttname"><a href="classost_1_1_thread_queue.html#a1737937abcd8b410758d47d18b651e40">ost::ThreadQueue::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> buffer.h:278</div></div>
<div class="ttc" id="classost_1_1_buffer_html_a9d106bd44d9bee8d9ef049cfa264e5b7"><div class="ttname"><a href="classost_1_1_buffer.html#a9d106bd44d9bee8d9ef049cfa264e5b7">ost::Buffer::post</a></div><div class="ttdeci">size_t post(void *buf, timeout_t timeout=0)</div><div class="ttdoc">Post an object into the buffer and enable a waiting thread to receive it. </div></div>
<div class="ttc" id="classost_1_1_mutex_html"><div class="ttname"><a href="classost_1_1_mutex.html">ost::Mutex</a></div><div class="ttdoc">The Mutex class is used to protect a section of code so that at any given time only a single thread c...</div><div class="ttdef"><b>Definition:</b> thread.h:186</div></div>
<div class="ttc" id="classost_1_1_thread_html"><div class="ttname"><a href="classost_1_1_thread.html">ost::Thread</a></div><div class="ttdoc">Every thread of execution in an application is created by instantiating an object of a class derived ...</div><div class="ttdef"><b>Definition:</b> thread.h:1093</div></div>
<div class="ttc" id="classost_1_1_thread_queue_html_adaf42df577b955fcea0dad9dd8a61202"><div class="ttname"><a href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202">ost::ThreadQueue::timeout</a></div><div class="ttdeci">timeout_t timeout</div><div class="ttdef"><b>Definition:</b> buffer.h:273</div></div>
<div class="ttc" id="classost_1_1_thread_queue_html"><div class="ttname"><a href="classost_1_1_thread_queue.html">ost::ThreadQueue</a></div><div class="ttdoc">Somewhat generic queue processing class to establish a producer consumer queue. </div><div class="ttdef"><b>Definition:</b> buffer.h:261</div></div>
<div class="ttc" id="classost_1_1_fixed_buffer_html"><div class="ttname"><a href="classost_1_1_fixed_buffer.html">ost::FixedBuffer</a></div><div class="ttdoc">A buffer class that holds a known capacity of fixed sized objects defined during creation. </div><div class="ttdef"><b>Definition:</b> buffer.h:190</div></div>
<div class="ttc" id="classost_1_1_semaphore_html"><div class="ttname"><a href="classost_1_1_semaphore.html">ost::Semaphore</a></div><div class="ttdoc">A semaphore is generally used as a synchronization object between multiple threads or to protect a li...</div><div class="ttdef"><b>Definition:</b> thread.h:733</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:56 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
