<!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"/>
<title>Universal Software Radio Peripheral: circular_buffer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Universal Software Radio Peripheral</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>circular_buffer.h</h1> </div>
</div>
<div class="contents">
<a href="circular__buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2006 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _CIRCULAR_BUFFER_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _CIRCULAR_BUFFER_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="mld__threads_8h.html">mld_threads.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdexcept></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef DO_DEBUG</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define DO_DEBUG 0</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#if DO_DEBUG</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define DEBUG(X) do{X} while(0);</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00036"></a><a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">00036</a> <span class="preprocessor"></span><span class="preprocessor">#define DEBUG(X) do{} while(0);</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a><a class="code" href="classcircular__buffer.html">00039</a> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classcircular__buffer.html">circular_buffer</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">private</span>:
<a name="l00042"></a>00042 <span class="comment">// the buffer to use</span>
<a name="l00043"></a>00043 T* d_buffer;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment">// the following are in Items (type T)</span>
<a name="l00046"></a>00046 UInt32 d_bufLen_I, d_readNdx_I, d_writeNdx_I;
<a name="l00047"></a>00047 UInt32 d_n_avail_write_I, d_n_avail_read_I;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// stuff to control access to class internals</span>
<a name="l00050"></a>00050 <a class="code" href="classmld__mutex__t.html">mld_mutex_ptr</a> d_internal;
<a name="l00051"></a>00051 <a class="code" href="classmld__condition__t.html">mld_condition_ptr</a> d_readBlock, d_writeBlock;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// booleans to decide how to control reading, writing, and aborting</span>
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> d_doWriteBlock, d_doFullRead, d_doAbort;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keywordtype">void</span> delete_mutex_cond () {
<a name="l00057"></a>00057 <span class="keywordflow">if</span> (d_internal) {
<a name="l00058"></a>00058 <span class="keyword">delete</span> d_internal;
<a name="l00059"></a>00059 d_internal = NULL;
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061 <span class="keywordflow">if</span> (d_readBlock) {
<a name="l00062"></a>00062 <span class="keyword">delete</span> d_readBlock;
<a name="l00063"></a>00063 d_readBlock = NULL;
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065 <span class="keywordflow">if</span> (d_writeBlock) {
<a name="l00066"></a>00066 <span class="keyword">delete</span> d_writeBlock;
<a name="l00067"></a>00067 d_writeBlock = NULL;
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">public</span>:
<a name="l00072"></a><a class="code" href="classcircular__buffer.html#af87896a1a606e366bcc0ee8f7f0cf36e">00072</a> <a class="code" href="classcircular__buffer.html#af87896a1a606e366bcc0ee8f7f0cf36e">circular_buffer</a> (UInt32 bufLen_I,
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> doWriteBlock = <span class="keyword">true</span>, <span class="keywordtype">bool</span> doFullRead = <span class="keyword">false</span>) {
<a name="l00074"></a>00074 <span class="keywordflow">if</span> (bufLen_I == 0)
<a name="l00075"></a>00075 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer(): "</span>
<a name="l00076"></a>00076 <span class="stringliteral">"Number of items to buffer must be > 0.\n"</span>);
<a name="l00077"></a>00077 d_bufLen_I = bufLen_I;
<a name="l00078"></a>00078 d_buffer = (T*) <span class="keyword">new</span> T[d_bufLen_I];
<a name="l00079"></a>00079 d_doWriteBlock = doWriteBlock;
<a name="l00080"></a>00080 d_doFullRead = doFullRead;
<a name="l00081"></a>00081 d_internal = NULL;
<a name="l00082"></a>00082 d_readBlock = d_writeBlock = NULL;
<a name="l00083"></a>00083 <a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> ();
<a name="l00084"></a>00084 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"c_b(): buf len (items) = %ld, "</span>
<a name="l00085"></a>00085 <span class="stringliteral">"doWriteBlock = %s, doFullRead = %s\n"</span>, d_bufLen_I,
<a name="l00086"></a>00086 (d_doWriteBlock ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>),
<a name="l00087"></a>00087 (d_doFullRead ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>)););
<a name="l00088"></a>00088 };
<a name="l00089"></a>00089
<a name="l00090"></a><a class="code" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">00090</a> <a class="code" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">~circular_buffer</a> () {
<a name="l00091"></a>00091 delete_mutex_cond ();
<a name="l00092"></a>00092 <span class="keyword">delete</span> [] d_buffer;
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a><a class="code" href="classcircular__buffer.html#a728e983738d3128fc328d7545d6505ec">00095</a> <span class="keyword">inline</span> UInt32 <a class="code" href="classcircular__buffer.html#a728e983738d3128fc328d7545d6505ec">n_avail_write_items</a> () {
<a name="l00096"></a>00096 d_internal-><a class="code" href="classmld__mutex__t.html#a76f6cb18d23e453b62eb5f7bcb8e14c5">lock</a> ();
<a name="l00097"></a>00097 UInt32 retVal = d_n_avail_write_I;
<a name="l00098"></a>00098 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00099"></a>00099 <span class="keywordflow">return</span> (retVal);
<a name="l00100"></a>00100 };
<a name="l00101"></a>00101
<a name="l00102"></a><a class="code" href="classcircular__buffer.html#a3552cefda9ed6a92931d286188f5c1aa">00102</a> <span class="keyword">inline</span> UInt32 <a class="code" href="classcircular__buffer.html#a3552cefda9ed6a92931d286188f5c1aa">n_avail_read_items</a> () {
<a name="l00103"></a>00103 d_internal-><a class="code" href="classmld__mutex__t.html#a76f6cb18d23e453b62eb5f7bcb8e14c5">lock</a> ();
<a name="l00104"></a>00104 UInt32 retVal = d_n_avail_read_I;
<a name="l00105"></a>00105 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00106"></a>00106 <span class="keywordflow">return</span> (retVal);
<a name="l00107"></a>00107 };
<a name="l00108"></a>00108
<a name="l00109"></a><a class="code" href="classcircular__buffer.html#ab64fa2266a00d4da83bc471db7d9d676">00109</a> <span class="keyword">inline</span> UInt32 <a class="code" href="classcircular__buffer.html#ab64fa2266a00d4da83bc471db7d9d676">buffer_length_items</a> () {<span class="keywordflow">return</span> (d_bufLen_I);};
<a name="l00110"></a><a class="code" href="classcircular__buffer.html#aadcd544c25a138781fa6e0e43b49665d">00110</a> <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);};
<a name="l00111"></a><a class="code" href="classcircular__buffer.html#aa1af3c61175877bd0fe3baf2130ce65c">00111</a> <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);};
<a name="l00112"></a>00112
<a name="l00113"></a><a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">00113</a> <span class="keywordtype">void</span> <a class="code" href="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> () {
<a name="l00114"></a>00114 d_doAbort = <span class="keyword">false</span>;
<a name="l00115"></a>00115 bzero (d_buffer, d_bufLen_I * <span class="keyword">sizeof</span> (T));
<a name="l00116"></a>00116 d_readNdx_I = d_writeNdx_I = d_n_avail_read_I = 0;
<a name="l00117"></a>00117 d_n_avail_write_I = d_bufLen_I;
<a name="l00118"></a>00118 delete_mutex_cond ();
<a name="l00119"></a>00119 <span class="comment">// create a mutex to handle contention of shared resources;</span>
<a name="l00120"></a>00120 <span class="comment">// any routine needed access to shared resources uses lock()</span>
<a name="l00121"></a>00121 <span class="comment">// before doing anything, then unlock() when finished.</span>
<a name="l00122"></a>00122 d_internal = <span class="keyword">new</span> <a class="code" href="mld__threads_8h.html#a859af1cfae142e50e8047d56eb8da096">mld_mutex</a> ();
<a name="l00123"></a>00123 <span class="comment">// link the internal mutex to the read and write conditions;</span>
<a name="l00124"></a>00124 <span class="comment">// when wait() is called, the internal mutex will automatically</span>
<a name="l00125"></a>00125 <span class="comment">// be unlock()'ed. Upon return (from a signal() to the condition),</span>
<a name="l00126"></a>00126 <span class="comment">// the internal mutex will be lock()'ed.</span>
<a name="l00127"></a>00127 d_readBlock = <span class="keyword">new</span> <a class="code" href="mld__threads_8h.html#ace77a34970d37487311bdd2e6eacb41b">mld_condition</a> (d_internal);
<a name="l00128"></a>00128 d_writeBlock = <span class="keyword">new</span> <a class="code" href="mld__threads_8h.html#ace77a34970d37487311bdd2e6eacb41b">mld_condition</a> (d_internal);
<a name="l00129"></a>00129 };
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">/*</span>
<a name="l00132"></a>00132 <span class="comment"> * enqueue: add the given buffer of item-length to the queue,</span>
<a name="l00133"></a>00133 <span class="comment"> * first-in-first-out (FIFO).</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * inputs:</span>
<a name="l00136"></a>00136 <span class="comment"> * buf: a pointer to the buffer holding the data</span>
<a name="l00137"></a>00137 <span class="comment"> *</span>
<a name="l00138"></a>00138 <span class="comment"> * bufLen_I: the buffer length in items (of the instantiated type)</span>
<a name="l00139"></a>00139 <span class="comment"> *</span>
<a name="l00140"></a>00140 <span class="comment"> * returns:</span>
<a name="l00141"></a>00141 <span class="comment"> * -1: on overflow (write is not blocking, and data is being</span>
<a name="l00142"></a>00142 <span class="comment"> * written faster than it is being read)</span>
<a name="l00143"></a>00143 <span class="comment"> * 0: if nothing to do (0 length buffer)</span>
<a name="l00144"></a>00144 <span class="comment"> * 1: if success</span>
<a name="l00145"></a>00145 <span class="comment"> * 2: in the process of aborting, do doing nothing</span>
<a name="l00146"></a>00146 <span class="comment"> *</span>
<a name="l00147"></a>00147 <span class="comment"> * will throw runtime errors if inputs are improper:</span>
<a name="l00148"></a>00148 <span class="comment"> * buffer pointer is NULL</span>
<a name="l00149"></a>00149 <span class="comment"> * buffer length is larger than the instantiated buffer length</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151
<a name="l00152"></a><a class="code" href="classcircular__buffer.html#a26fe1ca202c4aa2d324612b0b8beedd9">00152</a> <span class="keywordtype">int</span> <a class="code" href="classcircular__buffer.html#a26fe1ca202c4aa2d324612b0b8beedd9">enqueue</a> (T* buf, UInt32 bufLen_I) {
<a name="l00153"></a>00153 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"enqueue: buf = %X, bufLen = %ld, #av_wr = %ld, "</span>
<a name="l00154"></a>00154 <span class="stringliteral">"#av_rd = %ld.\n"</span>, (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)buf, bufLen_I,
<a name="l00155"></a>00155 d_n_avail_write_I, d_n_avail_read_I););
<a name="l00156"></a>00156 <span class="keywordflow">if</span> (bufLen_I > d_bufLen_I) {
<a name="l00157"></a>00157 fprintf (stderr, <span class="stringliteral">"cannot add buffer longer (%ld"</span>
<a name="l00158"></a>00158 <span class="stringliteral">") than instantiated length (%ld"</span>
<a name="l00159"></a>00159 <span class="stringliteral">").\n"</span>, bufLen_I, d_bufLen_I);
<a name="l00160"></a>00160 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer::enqueue()"</span>);
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keywordflow">if</span> (bufLen_I == 0)
<a name="l00164"></a>00164 <span class="keywordflow">return</span> (0);
<a name="l00165"></a>00165 <span class="keywordflow">if</span> (!buf)
<a name="l00166"></a>00166 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer::enqueue(): "</span>
<a name="l00167"></a>00167 <span class="stringliteral">"input buffer is NULL.\n"</span>);
<a name="l00168"></a>00168 d_internal-><a class="code" href="classmld__mutex__t.html#a76f6cb18d23e453b62eb5f7bcb8e14c5">lock</a> ();
<a name="l00169"></a>00169 <span class="keywordflow">if</span> (d_doAbort) {
<a name="l00170"></a>00170 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00171"></a>00171 <span class="keywordflow">return</span> (2);
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173 <span class="comment">// set the return value to 1: success; change if needed</span>
<a name="l00174"></a>00174 <span class="keywordtype">int</span> retval = 1;
<a name="l00175"></a>00175 <span class="keywordflow">if</span> (bufLen_I > d_n_avail_write_I) {
<a name="l00176"></a>00176 <span class="keywordflow">if</span> (d_doWriteBlock) {
<a name="l00177"></a>00177 <span class="keywordflow">while</span> (bufLen_I > d_n_avail_write_I) {
<a name="l00178"></a>00178 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"enqueue: #len > #a, waiting.\n"</span>););
<a name="l00179"></a>00179 <span class="comment">// wait will automatically unlock() the internal mutex</span>
<a name="l00180"></a>00180 d_writeBlock-><a class="code" href="classmld__condition__t.html#acbe1a1d16881771f6c42a24585c579f7">wait</a> ();
<a name="l00181"></a>00181 <span class="comment">// and lock() it here.</span>
<a name="l00182"></a>00182 <span class="keywordflow">if</span> (d_doAbort) {
<a name="l00183"></a>00183 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00184"></a>00184 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"enqueue: #len > #a, aborting.\n"</span>););
<a name="l00185"></a>00185 <span class="keywordflow">return</span> (2);
<a name="l00186"></a>00186 }
<a name="l00187"></a>00187 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"enqueue: #len > #a, done waiting.\n"</span>););
<a name="l00188"></a>00188 }
<a name="l00189"></a>00189 } <span class="keywordflow">else</span> {
<a name="l00190"></a>00190 d_n_avail_read_I = d_bufLen_I - bufLen_I;
<a name="l00191"></a>00191 d_n_avail_write_I = bufLen_I;
<a name="l00192"></a>00192 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"circular_buffer::enqueue: overflow\n"</span>););
<a name="l00193"></a>00193 retval = -1;
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196 UInt32 n_now_I = d_bufLen_I - d_writeNdx_I, n_start_I = 0;
<a name="l00197"></a>00197 <span class="keywordflow">if</span> (n_now_I > bufLen_I)
<a name="l00198"></a>00198 n_now_I = bufLen_I;
<a name="l00199"></a>00199 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (n_now_I < bufLen_I)
<a name="l00200"></a>00200 n_start_I = bufLen_I - n_now_I;
<a name="l00201"></a>00201 bcopy (buf, &(d_buffer[d_writeNdx_I]), n_now_I * <span class="keyword">sizeof</span> (T));
<a name="l00202"></a>00202 <span class="keywordflow">if</span> (n_start_I) {
<a name="l00203"></a>00203 bcopy (&(buf[n_now_I]), d_buffer, n_start_I * <span class="keyword">sizeof</span> (T));
<a name="l00204"></a>00204 d_writeNdx_I = n_start_I;
<a name="l00205"></a>00205 } <span class="keywordflow">else</span>
<a name="l00206"></a>00206 d_writeNdx_I += n_now_I;
<a name="l00207"></a>00207 d_n_avail_read_I += bufLen_I;
<a name="l00208"></a>00208 d_n_avail_write_I -= bufLen_I;
<a name="l00209"></a>00209 d_readBlock-><a class="code" href="classmld__condition__t.html#accd513ad8f802bc43fa3e54c469542c2">signal</a> ();
<a name="l00210"></a>00210 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00211"></a>00211 <span class="keywordflow">return</span> (retval);
<a name="l00212"></a>00212 };
<a name="l00213"></a>00213
<a name="l00214"></a>00214 <span class="comment">/*</span>
<a name="l00215"></a>00215 <span class="comment"> * dequeue: removes from the queue the number of items requested, or</span>
<a name="l00216"></a>00216 <span class="comment"> * available, into the given buffer on a FIFO basis.</span>
<a name="l00217"></a>00217 <span class="comment"> *</span>
<a name="l00218"></a>00218 <span class="comment"> * inputs:</span>
<a name="l00219"></a>00219 <span class="comment"> * buf: a pointer to the buffer into which to copy the data</span>
<a name="l00220"></a>00220 <span class="comment"> *</span>
<a name="l00221"></a>00221 <span class="comment"> * bufLen_I: pointer to the number of items to remove in items</span>
<a name="l00222"></a>00222 <span class="comment"> * (of the instantiated type)</span>
<a name="l00223"></a>00223 <span class="comment"> *</span>
<a name="l00224"></a>00224 <span class="comment"> * returns:</span>
<a name="l00225"></a>00225 <span class="comment"> * 0: if nothing to do (0 length buffer)</span>
<a name="l00226"></a>00226 <span class="comment"> * 1: if success</span>
<a name="l00227"></a>00227 <span class="comment"> * 2: in the process of aborting, do doing nothing</span>
<a name="l00228"></a>00228 <span class="comment"> *</span>
<a name="l00229"></a>00229 <span class="comment"> * will throw runtime errors if inputs are improper:</span>
<a name="l00230"></a>00230 <span class="comment"> * buffer pointer is NULL</span>
<a name="l00231"></a>00231 <span class="comment"> * buffer length pointer is NULL</span>
<a name="l00232"></a>00232 <span class="comment"> * buffer length is larger than the instantiated buffer length</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a>00234
<a name="l00235"></a><a class="code" href="classcircular__buffer.html#a4411197cc0fbf929538ba2ec2aeb3bab">00235</a> <span class="keywordtype">int</span> <a class="code" href="classcircular__buffer.html#a4411197cc0fbf929538ba2ec2aeb3bab">dequeue</a> (T* buf, UInt32* bufLen_I) {
<a name="l00236"></a>00236 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: buf = %X, *bufLen = %ld, #av_wr = %ld, "</span>
<a name="l00237"></a>00237 <span class="stringliteral">"#av_rd = %ld.\n"</span>, (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)buf, *bufLen_I,
<a name="l00238"></a>00238 d_n_avail_write_I, d_n_avail_read_I););
<a name="l00239"></a>00239 <span class="keywordflow">if</span> (!bufLen_I)
<a name="l00240"></a>00240 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer::dequeue(): "</span>
<a name="l00241"></a>00241 <span class="stringliteral">"input bufLen pointer is NULL.\n"</span>);
<a name="l00242"></a>00242 <span class="keywordflow">if</span> (!buf)
<a name="l00243"></a>00243 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer::dequeue(): "</span>
<a name="l00244"></a>00244 <span class="stringliteral">"input buffer pointer is NULL.\n"</span>);
<a name="l00245"></a>00245 UInt32 l_bufLen_I = *bufLen_I;
<a name="l00246"></a>00246 <span class="keywordflow">if</span> (l_bufLen_I == 0)
<a name="l00247"></a>00247 <span class="keywordflow">return</span> (0);
<a name="l00248"></a>00248 <span class="keywordflow">if</span> (l_bufLen_I > d_bufLen_I) {
<a name="l00249"></a>00249 fprintf (stderr, <span class="stringliteral">"cannot remove buffer longer (%ld"</span>
<a name="l00250"></a>00250 <span class="stringliteral">") than instantiated length (%ld"</span>
<a name="l00251"></a>00251 <span class="stringliteral">").\n"</span>, l_bufLen_I, d_bufLen_I);
<a name="l00252"></a>00252 <span class="keywordflow">throw</span> std::runtime_error (<span class="stringliteral">"circular_buffer::dequeue()"</span>);
<a name="l00253"></a>00253 }
<a name="l00254"></a>00254
<a name="l00255"></a>00255 d_internal-><a class="code" href="classmld__mutex__t.html#a76f6cb18d23e453b62eb5f7bcb8e14c5">lock</a> ();
<a name="l00256"></a>00256 <span class="keywordflow">if</span> (d_doAbort) {
<a name="l00257"></a>00257 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00258"></a>00258 <span class="keywordflow">return</span> (2);
<a name="l00259"></a>00259 }
<a name="l00260"></a>00260 <span class="keywordflow">if</span> (d_doFullRead) {
<a name="l00261"></a>00261 <span class="keywordflow">while</span> (d_n_avail_read_I < l_bufLen_I) {
<a name="l00262"></a>00262 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a < #len, waiting.\n"</span>););
<a name="l00263"></a>00263 <span class="comment">// wait will automatically unlock() the internal mutex</span>
<a name="l00264"></a>00264 d_readBlock-><a class="code" href="classmld__condition__t.html#acbe1a1d16881771f6c42a24585c579f7">wait</a> ();
<a name="l00265"></a>00265 <span class="comment">// and lock() it here.</span>
<a name="l00266"></a>00266 <span class="keywordflow">if</span> (d_doAbort) {
<a name="l00267"></a>00267 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00268"></a>00268 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a < #len, aborting.\n"</span>););
<a name="l00269"></a>00269 <span class="keywordflow">return</span> (2);
<a name="l00270"></a>00270 }
<a name="l00271"></a>00271 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a < #len, done waiting.\n"</span>););
<a name="l00272"></a>00272 }
<a name="l00273"></a>00273 } <span class="keywordflow">else</span> {
<a name="l00274"></a>00274 <span class="keywordflow">while</span> (d_n_avail_read_I == 0) {
<a name="l00275"></a>00275 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a == 0, waiting.\n"</span>););
<a name="l00276"></a>00276 <span class="comment">// wait will automatically unlock() the internal mutex</span>
<a name="l00277"></a>00277 d_readBlock-><a class="code" href="classmld__condition__t.html#acbe1a1d16881771f6c42a24585c579f7">wait</a> ();
<a name="l00278"></a>00278 <span class="comment">// and lock() it here.</span>
<a name="l00279"></a>00279 <span class="keywordflow">if</span> (d_doAbort) {
<a name="l00280"></a>00280 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00281"></a>00281 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a == 0, aborting.\n"</span>););
<a name="l00282"></a>00282 <span class="keywordflow">return</span> (2);
<a name="l00283"></a>00283 }
<a name="l00284"></a>00284 <a class="code" href="circular__buffer_8h.html#aef41e8aaf4c60819b30faf396cdf4978">DEBUG</a> (fprintf (stderr, <span class="stringliteral">"dequeue: #a == 0, done waiting.\n"</span>););
<a name="l00285"></a>00285 }
<a name="l00286"></a>00286 }
<a name="l00287"></a>00287 <span class="keywordflow">if</span> (l_bufLen_I > d_n_avail_read_I)
<a name="l00288"></a>00288 l_bufLen_I = d_n_avail_read_I;
<a name="l00289"></a>00289 UInt32 n_now_I = d_bufLen_I - d_readNdx_I, n_start_I = 0;
<a name="l00290"></a>00290 <span class="keywordflow">if</span> (n_now_I > l_bufLen_I)
<a name="l00291"></a>00291 n_now_I = l_bufLen_I;
<a name="l00292"></a>00292 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (n_now_I < l_bufLen_I)
<a name="l00293"></a>00293 n_start_I = l_bufLen_I - n_now_I;
<a name="l00294"></a>00294 bcopy (&(d_buffer[d_readNdx_I]), buf, n_now_I * <span class="keyword">sizeof</span> (T));
<a name="l00295"></a>00295 <span class="keywordflow">if</span> (n_start_I) {
<a name="l00296"></a>00296 bcopy (d_buffer, &(buf[n_now_I]), n_start_I * <span class="keyword">sizeof</span> (T));
<a name="l00297"></a>00297 d_readNdx_I = n_start_I;
<a name="l00298"></a>00298 } <span class="keywordflow">else</span>
<a name="l00299"></a>00299 d_readNdx_I += n_now_I;
<a name="l00300"></a>00300 *bufLen_I = l_bufLen_I;
<a name="l00301"></a>00301 d_n_avail_read_I -= l_bufLen_I;
<a name="l00302"></a>00302 d_n_avail_write_I += l_bufLen_I;
<a name="l00303"></a>00303 d_writeBlock-><a class="code" href="classmld__condition__t.html#accd513ad8f802bc43fa3e54c469542c2">signal</a> ();
<a name="l00304"></a>00304 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00305"></a>00305 <span class="keywordflow">return</span> (1);
<a name="l00306"></a>00306 };
<a name="l00307"></a>00307
<a name="l00308"></a><a class="code" href="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">00308</a> <span class="keywordtype">void</span> <a class="code" href="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">abort</a> () {
<a name="l00309"></a>00309 d_internal-><a class="code" href="classmld__mutex__t.html#a76f6cb18d23e453b62eb5f7bcb8e14c5">lock</a> ();
<a name="l00310"></a>00310 d_doAbort = <span class="keyword">true</span>;
<a name="l00311"></a>00311 d_writeBlock-><a class="code" href="classmld__condition__t.html#accd513ad8f802bc43fa3e54c469542c2">signal</a> ();
<a name="l00312"></a>00312 d_readBlock-><a class="code" href="classmld__condition__t.html#accd513ad8f802bc43fa3e54c469542c2">signal</a> ();
<a name="l00313"></a>00313 d_internal-><a class="code" href="classmld__mutex__t.html#a92ab8c4ffde527dc16b3ca79bc6e5cb5">unlock</a> ();
<a name="l00314"></a>00314 };
<a name="l00315"></a>00315 };
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="preprocessor">#endif </span><span class="comment">/* _CIRCULAR_BUFFER_H_ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Feb 17 2011 for Universal Software Radio Peripheral by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
9000
