Sophie

Sophie

distrib > Mageia > 3 > i586 > by-pkgid > d2c3cd0736fcf741288cdfea8c6ba8c2 > files > 607

gnuradio-doc-3.6.4.1-1.mga3.noarch.rpm

<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: circular_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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</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 Radio 3.6.4.1 C++ API
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('circular__buffer_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">circular_buffer.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="circular__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>&#160;<span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2006,2009,2010 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This file is part of GNU Radio.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef _CIRCULAR_BUFFER_H_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _CIRCULAR_BUFFER_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="thread_8h.html">gruel/thread.h</a>&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;stdexcept&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#ifndef DO_DEBUG</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="circular__buffer_8h.html#a6748a559cfa5d68a4eb3ab5e8f644033">   31</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define DO_DEBUG 0</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#if DO_DEBUG</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define DEBUG(X) do{X} while(0);</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">   37</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define DEBUG(X) do{} while(0);</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classcircular__buffer.html">   41</a></span>&#160;<span class="keyword">class </span><a class="code" href="classcircular__buffer.html">circular_buffer</a></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;{</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">// the buffer to use</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  T* d_buffer;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">// the following are in Items (type T)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="keywordtype">size_t</span> d_bufLen_I, d_readNdx_I, d_writeNdx_I;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="keywordtype">size_t</span> d_n_avail_write_I, d_n_avail_read_I;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">// stuff to control access to class internals</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <a class="code" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a>* d_internal;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <a class="code" href="namespacegruel.html#a7f31867c7b47853d55962183d0a4e999">gruel::condition_variable</a>* d_readBlock;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <a class="code" href="namespacegruel.html#a7f31867c7b47853d55962183d0a4e999">gruel::condition_variable</a>* d_writeBlock;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">// booleans to decide how to control reading, writing, and aborting</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="keywordtype">bool</span> d_doWriteBlock, d_doFullRead, d_doAbort;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  <span class="keywordtype">void</span> delete_mutex_cond () {</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <span class="keywordflow">if</span> (d_internal) {</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;      <span class="keyword">delete</span> d_internal;</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;      d_internal = NULL;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    }</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">if</span> (d_readBlock) {</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;      <span class="keyword">delete</span> d_readBlock;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;      d_readBlock = NULL;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    }</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keywordflow">if</span> (d_writeBlock) {</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;      <span class="keyword">delete</span> d_writeBlock;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;      d_writeBlock = NULL;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    }</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  };</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#abe47d88305c64a91fa8fb6fe10b63bb0">   75</a></span>&#160;  <a class="code" href="classcircular__buffer.html#abe47d88305c64a91fa8fb6fe10b63bb0">circular_buffer</a> (<span class="keywordtype">size_t</span> bufLen_I,</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;                   <span class="keywordtype">bool</span> doWriteBlock = <span class="keyword">true</span>, <span class="keywordtype">bool</span> doFullRead = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="keywordflow">if</span> (bufLen_I == 0)</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer(): &quot;</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                                <span class="stringliteral">&quot;Number of items to buffer must be &gt; 0.\n&quot;</span>);</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    d_bufLen_I = bufLen_I;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    d_buffer = (T*) <span class="keyword">new</span> T[d_bufLen_I];</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    d_doWriteBlock = doWriteBlock;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    d_doFullRead = doFullRead;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    d_internal = NULL;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    d_readBlock = d_writeBlock = NULL;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> ();</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;c_b(): buf len (items) = &quot;</span> &lt;&lt; d_bufLen_</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, doWriteBlock = &quot;</span> &lt;&lt; (d_doWriteBlock ? <span class="stringliteral">&quot;true&quot;</span> : <span class="stringliteral">&quot;false&quot;</span>)</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, doFullRead = &quot;</span> &lt;&lt; (d_doFullRead ? <span class="stringliteral">&quot;true&quot;</span> : <span class="stringliteral">&quot;false&quot;</span>)</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;           &lt;&lt; std::endl);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  };</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">   93</a></span>&#160;  <a class="code" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">~circular_buffer</a> () {</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    delete_mutex_cond ();</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keyword">delete</span> [] d_buffer;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  };</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a7b17b62a2c64f5b86759268b4439c00f">   98</a></span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classcircular__buffer.html#a7b17b62a2c64f5b86759268b4439c00f">n_avail_write_items</a> () {</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <a class="code" href="namespacegruel.html#a93eaa071dca707d684d1ba1ee4ca74c5">gruel::scoped_lock</a> l (*d_internal);</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="keywordtype">size_t</span> retVal = d_n_avail_write_I;</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <span class="keywordflow">return</span> (retVal);</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  };</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a8118badb1d022ba8f0497f24cec96b75">  104</a></span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classcircular__buffer.html#a8118badb1d022ba8f0497f24cec96b75">n_avail_read_items</a> () {</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    <a class="code" href="namespacegruel.html#a93eaa071dca707d684d1ba1ee4ca74c5">gruel::scoped_lock</a> l (*d_internal);</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <span class="keywordtype">size_t</span> retVal = d_n_avail_read_I;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordflow">return</span> (retVal);</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  };</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a9d3199c0412409093c23518771d6acf4">  110</a></span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classcircular__buffer.html#a9d3199c0412409093c23518771d6acf4">buffer_length_items</a> () {<span class="keywordflow">return</span> (d_bufLen_I);};</div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#aadcd544c25a138781fa6e0e43b49665d">  111</a></span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classcircular__buffer.html#aadcd544c25a138781fa6e0e43b49665d">do_write_block</a> () {<span class="keywordflow">return</span> (d_doWriteBlock);};</div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#aa1af3c61175877bd0fe3baf2130ce65c">  112</a></span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classcircular__buffer.html#aa1af3c61175877bd0fe3baf2130ce65c">do_full_read</a> () {<span class="keywordflow">return</span> (d_doFullRead);};</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">  114</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> () {</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    d_doAbort = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    bzero (d_buffer, d_bufLen_I * <span class="keyword">sizeof</span> (T));</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    d_readNdx_I = d_writeNdx_I = d_n_avail_read_I = 0;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    d_n_avail_write_I = d_bufLen_I;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    delete_mutex_cond ();</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="comment">// create a mutex to handle contention of shared resources;</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="comment">// any routine needed access to shared resources uses lock()</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <span class="comment">// before doing anything, then unlock() when finished.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    d_internal = <span class="keyword">new</span> <a class="code" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a> ();</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="comment">// link the internal mutex to the read and write conditions;</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <span class="comment">// when wait() is called, the internal mutex will automatically</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    <span class="comment">// be unlock()&#39;ed.  Upon return (from a notify_one() to the condition),</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="comment">// the internal mutex will be lock()&#39;ed.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    d_readBlock = <span class="keyword">new</span> <a class="code" href="namespacegruel.html#a7f31867c7b47853d55962183d0a4e999">gruel::condition_variable</a> ();</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    d_writeBlock = <span class="keyword">new</span> <a class="code" href="namespacegruel.html#a7f31867c7b47853d55962183d0a4e999">gruel::condition_variable</a> ();</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  };</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> * enqueue: add the given buffer of item-length to the queue,</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> *     first-in-first-out (FIFO).</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * inputs:</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> *     buf: a pointer to the buffer holding the data</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> *     bufLen_I: the buffer length in items (of the instantiated type)</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> * returns:</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> *    -1: on overflow (write is not blocking, and data is being</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> *                     written faster than it is being read)</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> *     0: if nothing to do (0 length buffer)</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> *     1: if success</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> *     2: in the process of aborting, do doing nothing</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * will throw runtime errors if inputs are improper:</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> *     buffer pointer is NULL</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> *     buffer length is larger than the instantiated buffer length</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;</div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#abcd24de17aa8258835c6dff2c027a6d6">  153</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classcircular__buffer.html#abcd24de17aa8258835c6dff2c027a6d6">enqueue</a> (T* buf, <span class="keywordtype">size_t</span> bufLen_I) {</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;enqueue: buf = &quot;</span> &lt;&lt; (<span class="keywordtype">void</span>*) buf</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, bufLen = &quot;</span> &lt;&lt; bufLen_I</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, #av_wr = &quot;</span> &lt;&lt; d_n_avail_write_I</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, #av_rd = &quot;</span> &lt;&lt; d_n_avail_read_I &lt;&lt; std::endl);</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    <span class="keywordflow">if</span> (bufLen_I &gt; d_bufLen_I) {</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;      std::cerr &lt;&lt; <span class="stringliteral">&quot;ERROR: cannot add buffer longer (&quot;</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;                &lt;&lt; bufLen_I &lt;&lt; <span class="stringliteral">&quot;) than instantiated length (&quot;</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;                &lt;&lt; d_bufLen_I &lt;&lt; <span class="stringliteral">&quot;).&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer::enqueue()&quot;</span>);</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    }</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    <span class="keywordflow">if</span> (bufLen_I == 0)</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;      <span class="keywordflow">return</span> (0);</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    <span class="keywordflow">if</span> (!buf)</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer::enqueue(): &quot;</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;                                <span class="stringliteral">&quot;input buffer is NULL.\n&quot;</span>);</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    <a class="code" href="namespacegruel.html#a93eaa071dca707d684d1ba1ee4ca74c5">gruel::scoped_lock</a> l (*d_internal);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    <span class="keywordflow">if</span> (d_doAbort) {</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;      <span class="keywordflow">return</span> (2);</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;    }</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    <span class="comment">// set the return value to 1: success; change if needed</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="gc__spu__macs_8h.html#a696b31d3fc8a0a0f24948f98d0e4a4d1">retval</a> = 1;</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    <span class="keywordflow">if</span> (bufLen_I &gt; d_n_avail_write_I) {</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;      <span class="keywordflow">if</span> (d_doWriteBlock) {</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;        <span class="keywordflow">while</span> (bufLen_I &gt; d_n_avail_write_I) {</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;          <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;enqueue: #len &gt; #a, waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;          <span class="comment">// wait; will automatically unlock() the internal mutex via</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;          <span class="comment">// the scoped lock</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;          d_writeBlock-&gt;wait (l);</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;          <span class="comment">// and auto re-lock() it here.</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;          <span class="keywordflow">if</span> (d_doAbort) {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;            <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;enqueue: #len &gt; #a, aborting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;            <span class="keywordflow">return</span> (2);</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;          }</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;          <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;enqueue: #len &gt; #a, done waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;        }</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;      } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;        d_n_avail_read_I = d_bufLen_I - bufLen_I;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;        d_n_avail_write_I = bufLen_I;</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;        <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;circular_buffer::enqueue: overflow&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        retval = -1;</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;      }</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;    }</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;    <span class="keywordtype">size_t</span> n_now_I = d_bufLen_I - d_writeNdx_I, n_start_I = 0;</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    <span class="keywordflow">if</span> (n_now_I &gt; bufLen_I)</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;      n_now_I = bufLen_I;</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;    <span class="keywordflow">else</span> <span class="keywordflow">if</span> (n_now_I &lt; bufLen_I)</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;      n_start_I = bufLen_I - n_now_I;</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;    bcopy (buf, &amp;(d_buffer[d_writeNdx_I]), n_now_I * <span class="keyword">sizeof</span> (T));</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;    <span class="keywordflow">if</span> (n_start_I) {</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;      bcopy (&amp;(buf[n_now_I]), d_buffer, n_start_I * <span class="keyword">sizeof</span> (T));</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;      d_writeNdx_I = n_start_I;</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;    } <span class="keywordflow">else</span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;      d_writeNdx_I += n_now_I;</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;    d_n_avail_read_I += bufLen_I;</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;    d_n_avail_write_I -= bufLen_I;</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;    d_readBlock-&gt;notify_one ();</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;    <span class="keywordflow">return</span> (retval);</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;  };</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment"> * dequeue: removes from the queue the number of items requested, or</span></div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"> *     available, into the given buffer on a FIFO basis.</span></div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment"> * inputs:</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment"> *     buf: a pointer to the buffer into which to copy the data</span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment"> *     bufLen_I: pointer to the number of items to remove in items</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment"> *         (of the instantiated type)</span></div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment"> * returns:</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"> *     0: if nothing to do (0 length buffer)</span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"> *     1: if success</span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"> *     2: in the process of aborting, do doing nothing</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"> * will throw runtime errors if inputs are improper:</span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment"> *     buffer pointer is NULL</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment"> *     buffer length pointer is NULL</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment"> *     buffer length is larger than the instantiated buffer length</span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;</div>
<div class="line"><a name="l00235"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a7f86491a41b04da07ed2f5b3dbc748d1">  235</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classcircular__buffer.html#a7f86491a41b04da07ed2f5b3dbc748d1">dequeue</a> (T* buf, <span class="keywordtype">size_t</span>* bufLen_I) {</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: buf = &quot;</span> &lt;&lt; ((<span class="keywordtype">void</span>*) buf)</div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, *bufLen = &quot;</span> &lt;&lt; (*bufLen_I)</div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, #av_wr = &quot;</span> &lt;&lt;  d_n_avail_write_I</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;           &lt;&lt; <span class="stringliteral">&quot;, #av_rd = &quot;</span> &lt;&lt; d_n_avail_read_I &lt;&lt; std::endl);</div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;    <span class="keywordflow">if</span> (!bufLen_I)</div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer::dequeue(): &quot;</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;                                <span class="stringliteral">&quot;input bufLen pointer is NULL.\n&quot;</span>);</div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;    <span class="keywordflow">if</span> (!buf)</div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer::dequeue(): &quot;</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;                                <span class="stringliteral">&quot;input buffer pointer is NULL.\n&quot;</span>);</div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    <span class="keywordtype">size_t</span> l_bufLen_I = *bufLen_I;</div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;    <span class="keywordflow">if</span> (l_bufLen_I == 0)</div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;      <span class="keywordflow">return</span> (0);</div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;    <span class="keywordflow">if</span> (l_bufLen_I &gt; d_bufLen_I) {</div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;      std::cerr &lt;&lt; <span class="stringliteral">&quot;ERROR: cannot remove buffer longer (&quot;</span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;                &lt;&lt; l_bufLen_I &lt;&lt; <span class="stringliteral">&quot;) than instantiated length (&quot;</span></div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;                &lt;&lt; d_bufLen_I &lt;&lt; <span class="stringliteral">&quot;).&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;      <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">&quot;circular_buffer::dequeue()&quot;</span>);</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;    }</div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;</div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;    <a class="code" href="namespacegruel.html#a93eaa071dca707d684d1ba1ee4ca74c5">gruel::scoped_lock</a> l (*d_internal);</div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;    <span class="keywordflow">if</span> (d_doAbort) {</div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;      <span class="keywordflow">return</span> (2);</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;    }</div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;    <span class="keywordflow">if</span> (d_doFullRead) {</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;      <span class="keywordflow">while</span> (d_n_avail_read_I &lt; l_bufLen_I) {</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;        <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a &lt; #len, waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;        <span class="comment">// wait; will automatically unlock() the internal mutex via</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;        <span class="comment">// the scoped lock</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;        d_readBlock-&gt;wait (l);</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;        <span class="comment">// and re-lock() it here.</span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;        <span class="keywordflow">if</span> (d_doAbort) {</div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;          <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a &lt; #len, aborting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;          <span class="keywordflow">return</span> (2);</div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;        }</div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;        <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a &lt; #len, done waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;     }</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;    } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;      <span class="keywordflow">while</span> (d_n_avail_read_I == 0) {</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;        <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a == 0, waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;        <span class="comment">// wait; will automatically unlock() the internal mutex via</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;        <span class="comment">// the scoped lock</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;        d_readBlock-&gt;wait (l);</div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;        <span class="comment">// and re-lock() it here.</span></div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;        <span class="keywordflow">if</span> (d_doAbort) {</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;          <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a == 0, aborting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;          <span class="keywordflow">return</span> (2);</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;        }</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;        <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (std::cerr &lt;&lt; <span class="stringliteral">&quot;dequeue: #a == 0, done waiting.&quot;</span> &lt;&lt; std::endl);</div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;      }</div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;    }</div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;    <span class="keywordflow">if</span> (l_bufLen_I &gt; d_n_avail_read_I)</div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;      l_bufLen_I = d_n_avail_read_I;</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;    <span class="keywordtype">size_t</span> n_now_I = d_bufLen_I - d_readNdx_I, n_start_I = 0;</div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;    <span class="keywordflow">if</span> (n_now_I &gt; l_bufLen_I)</div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;      n_now_I = l_bufLen_I;</div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;    <span class="keywordflow">else</span> <span class="keywordflow">if</span> (n_now_I &lt; l_bufLen_I)</div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;      n_start_I = l_bufLen_I - n_now_I;</div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;    bcopy (&amp;(d_buffer[d_readNdx_I]), buf, n_now_I * <span class="keyword">sizeof</span> (T));</div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;    <span class="keywordflow">if</span> (n_start_I) {</div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;      bcopy (d_buffer, &amp;(buf[n_now_I]), n_start_I * <span class="keyword">sizeof</span> (T));</div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;      d_readNdx_I = n_start_I;</div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;    } <span class="keywordflow">else</span></div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;      d_readNdx_I += n_now_I;</div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;    *bufLen_I = l_bufLen_I;</div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;    d_n_avail_read_I -= l_bufLen_I;</div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;    d_n_avail_write_I += l_bufLen_I;</div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;    d_writeBlock-&gt;notify_one ();</div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;    <span class="keywordflow">return</span> (1);</div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;  };</div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;</div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="code" href="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">  307</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">abort</a> () {</div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;    <a class="code" href="namespacegruel.html#a93eaa071dca707d684d1ba1ee4ca74c5">gruel::scoped_lock</a> l (*d_internal);</div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;    d_doAbort = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;    d_writeBlock-&gt;notify_one ();</div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;    d_readBlock-&gt;notify_one ();</div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;  };</div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;};</div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;</div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _CIRCULAR_BUFFER_H_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_b51bfcff293141bf770afcf028e6a44b.html">gr-audio</a></li><li class="navelem"><a class="el" href="dir_48891393b9833c1bfb94f2ceb7b7107d.html">lib</a></li><li class="navelem"><a class="el" href="dir_3f9191b72459aca51ccf239d1a9d8ded.html">osx</a></li><li class="navelem"><a class="el" href="circular__buffer_8h.html">circular_buffer.h</a></li>
    <li class="footer">Generated on Fri Apr 19 2013 16:20:32 for GNU Radio 3.6.4.1 C++ API by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
  </ul>
</div>
</body>
</html>