<!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>GNU Radio 3.2.2 C++ API: ring.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <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">GNU Radio 3.2.2 C++ API</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('ring_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>ring.h</h1> </div> </div> <div class="contents"> <a href="ring_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 2008 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 along</span> <a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span> <a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span> <a name="l00020"></a>00020 <span class="comment"> */</span> <a name="l00021"></a>00021 <span class="preprocessor">#ifndef INCLUDED_RING_H</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_RING_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <gnuradio/omnithread.h></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <stddef.h></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <vector></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <boost/shared_ptr.hpp></span> <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="keyword">namespace </span>usrp2 { <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">class </span>ring; <a name="l00032"></a>00032 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<ring></a> ring_sptr; <a name="l00033"></a>00033 <a name="l00034"></a><a class="code" href="classusrp2_1_1ring.html">00034</a> <span class="keyword">class </span><a class="code" href="classusrp2_1_1ring.html">ring</a> <a name="l00035"></a>00035 { <a name="l00036"></a>00036 <span class="keyword">private</span>: <a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="keywordtype">size_t</span> d_max; <a name="l00039"></a>00039 <span class="keywordtype">size_t</span> d_read_ind; <a name="l00040"></a>00040 <span class="keywordtype">size_t</span> d_write_ind; <a name="l00041"></a>00041 <a name="l00042"></a>00042 <span class="keyword">struct </span>ring_desc <a name="l00043"></a>00043 { <a name="l00044"></a>00044 <span class="keywordtype">void</span> *d_base; <a name="l00045"></a>00045 <span class="keywordtype">size_t</span> d_len; <a name="l00046"></a>00046 }; <a name="l00047"></a>00047 <a class="code" href="classstd_1_1vector.html">std::vector<ring_desc></a> d_ring; <a name="l00048"></a>00048 <a name="l00049"></a>00049 <a class="code" href="classomni__mutex.html">omni_mutex</a> d_mutex; <a name="l00050"></a>00050 <a class="code" href="classomni__condition.html">omni_condition</a> d_not_empty; <a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="keywordtype">void</span> inc_read_ind() <a name="l00053"></a>00053 { <a name="l00054"></a>00054 <span class="keywordflow">if</span> (d_read_ind + 1 >= d_max) <a name="l00055"></a>00055 d_read_ind = 0; <a name="l00056"></a>00056 <span class="keywordflow">else</span> <a name="l00057"></a>00057 d_read_ind = d_read_ind + 1; <a name="l00058"></a>00058 } <a name="l00059"></a>00059 <a name="l00060"></a>00060 <span class="keywordtype">void</span> inc_write_ind() <a name="l00061"></a>00061 { <a name="l00062"></a>00062 <span class="keywordflow">if</span> (d_write_ind + 1 >= d_max) <a name="l00063"></a>00063 d_write_ind = 0; <a name="l00064"></a>00064 <span class="keywordflow">else</span> <a name="l00065"></a>00065 d_write_ind = d_write_ind + 1; <a name="l00066"></a>00066 } <a name="l00067"></a>00067 <a name="l00068"></a>00068 <span class="keywordtype">bool</span> empty()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_read_ind == d_write_ind; } <a name="l00069"></a>00069 <span class="keywordtype">bool</span> full()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (d_write_ind+1)%d_max == d_read_ind; } <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="keyword">public</span>: <a name="l00072"></a>00072 <a name="l00073"></a>00073 <a class="code" href="classusrp2_1_1ring.html#a52d58f69ede431315f424c98da40e61f">ring</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> entries); <a name="l00074"></a>00074 <a name="l00075"></a>00075 <span class="keywordtype">void</span> <a class="code" href="classusrp2_1_1ring.html#a645c7168e6092be2d7a5d629ad6b8e04">wait_for_not_empty</a>(); <a name="l00076"></a>00076 <a name="l00077"></a>00077 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1ring.html#a0ecf8df1aa8a035b2ad403fb77279ac1">enqueue</a>(<span class="keywordtype">void</span> *p, <span class="keywordtype">size_t</span> len); <a name="l00078"></a>00078 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1ring.html#a42b6a68e92b63d6816458abf5e0e3d1f">dequeue</a>(<span class="keywordtype">void</span> **p, <span class="keywordtype">size_t</span> *len); <a name="l00079"></a>00079 }; <a name="l00080"></a>00080 <a name="l00081"></a>00081 } <span class="comment">// namespace usrp2</span> <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_RING_H */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="ring_8h.html">ring.h</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>