<!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: gr_buffer_reader Class Reference</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('classgr__buffer__reader.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_buffer_reader Class Reference<div class="ingroups"><a class="el" href="group__internal.html">Implementation Details</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_buffer_reader" -->
<p>How we keep track of the readers of a <a class="el" href="classgr__buffer.html" title="Single writer, multiple reader fifo.">gr_buffer</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__buffer_8h_source.html">gr_buffer.h</a>></code></p>
<p><a href="classgr__buffer__reader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classgr__buffer.html#aff98726da27f70ef316640f925636260">gr_buffer::scoped_lock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aa81c4b34f6e518e11cef52972a9a0c76">scoped_lock</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a296f93185ddabe97c74ee2bfc1858194">~gr_buffer_reader</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a1ef86082ac536ac95ec469f27d99d6a0">items_available</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of items available for reading. <a href="#a1ef86082ac536ac95ec469f27d99d6a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aa1f9fc3b86fea8da9cfdb6f693b0d8b1">buffer</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return buffer this reader reads from. <a href="#aa1f9fc3b86fea8da9cfdb6f693b0d8b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a87ef46cf000ef6168115b8b06cfd0ce8">max_possible_items_available</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return maximum number of items that could ever be available for reading. This is used as a sanity check in the scheduler to avoid looping forever. <a href="#a87ef46cf000ef6168115b8b06cfd0ce8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aa0a07401b38ed900cb53e72193233ddf">read_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return pointer to read buffer. <a href="#aa0a07401b38ed900cb53e72193233ddf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a6a8e969300be7ffa49811109f27005c4">update_read_pointer</a> (int nitems)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a8b550f828745a575387ead9701174665">set_done</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> done)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a1b0037b814e8576b279fe307c47dd5a5">done</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boost::mutex * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a789fe0fe9eb7968ab971d848452f3d5c">mutex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#acd78edc8986ecdb3b78a3add8e2ebfde">link</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the block that reads via this reader. <a href="#acd78edc8986ecdb3b78a3add8e2ebfde"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a25dff068f5cfde18c4307b4973f4db9d">gr_buffer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#afb5b9797c2e10e7f5d456643d3b420cb">gr_buffer_add_reader</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> buf, int nzero_preload, <a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> link)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a> and attach it to buffer <code>buf</code>. <a href="#afb5b9797c2e10e7f5d456643d3b420cb"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>How we keep track of the readers of a <a class="el" href="classgr__buffer.html" title="Single writer, multiple reader fifo.">gr_buffer</a>. </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aa81c4b34f6e518e11cef52972a9a0c76"></a><!-- doxytag: member="gr_buffer_reader::scoped_lock" ref="aa81c4b34f6e518e11cef52972a9a0c76" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classgr__buffer.html#aff98726da27f70ef316640f925636260">gr_buffer::scoped_lock</a> <a class="el" href="classgr__buffer__reader.html#aa81c4b34f6e518e11cef52972a9a0c76">gr_buffer_reader::scoped_lock</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a296f93185ddabe97c74ee2bfc1858194"></a><!-- doxytag: member="gr_buffer_reader::~gr_buffer_reader" ref="a296f93185ddabe97c74ee2bfc1858194" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_buffer_reader::~gr_buffer_reader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa1f9fc3b86fea8da9cfdb6f693b0d8b1"></a><!-- doxytag: member="gr_buffer_reader::buffer" ref="aa1f9fc3b86fea8da9cfdb6f693b0d8b1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> gr_buffer_reader::buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return buffer this reader reads from. </p>
</div>
</div>
<a class="anchor" id="a1b0037b814e8576b279fe307c47dd5a5"></a><!-- doxytag: member="gr_buffer_reader::done" ref="a1b0037b814e8576b279fe307c47dd5a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_buffer_reader::done </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1ef86082ac536ac95ec469f27d99d6a0"></a><!-- doxytag: member="gr_buffer_reader::items_available" ref="a1ef86082ac536ac95ec469f27d99d6a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_buffer_reader::items_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of items available for reading. </p>
</div>
</div>
<a class="anchor" id="acd78edc8986ecdb3b78a3add8e2ebfde"></a><!-- doxytag: member="gr_buffer_reader::link" ref="acd78edc8986ecdb3b78a3add8e2ebfde" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> gr_buffer_reader::link </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the block that reads via this reader. </p>
</div>
</div>
<a class="anchor" id="a87ef46cf000ef6168115b8b06cfd0ce8"></a><!-- doxytag: member="gr_buffer_reader::max_possible_items_available" ref="a87ef46cf000ef6168115b8b06cfd0ce8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_buffer_reader::max_possible_items_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return maximum number of items that could ever be available for reading. This is used as a sanity check in the scheduler to avoid looping forever. </p>
</div>
</div>
<a class="anchor" id="a789fe0fe9eb7968ab971d848452f3d5c"></a><!-- doxytag: member="gr_buffer_reader::mutex" ref="a789fe0fe9eb7968ab971d848452f3d5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::mutex* gr_buffer_reader::mutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa0a07401b38ed900cb53e72193233ddf"></a><!-- doxytag: member="gr_buffer_reader::read_pointer" ref="aa0a07401b38ed900cb53e72193233ddf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* gr_buffer_reader::read_pointer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return pointer to read buffer. </p>
<p>The return value points to <a class="el" href="classgr__buffer__reader.html#a1ef86082ac536ac95ec469f27d99d6a0" title="Return number of items available for reading.">items_available()</a> number of items </p>
</div>
</div>
<a class="anchor" id="a8b550f828745a575387ead9701174665"></a><!-- doxytag: member="gr_buffer_reader::set_done" ref="a8b550f828745a575387ead9701174665" args="(bool done)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_buffer_reader::set_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>done</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6a8e969300be7ffa49811109f27005c4"></a><!-- doxytag: member="gr_buffer_reader::update_read_pointer" ref="a6a8e969300be7ffa49811109f27005c4" args="(int nitems)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_buffer_reader::update_read_pointer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>nitems</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a25dff068f5cfde18c4307b4973f4db9d"></a><!-- doxytag: member="gr_buffer_reader::gr_buffer" ref="a25dff068f5cfde18c4307b4973f4db9d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgr__buffer.html">gr_buffer</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afb5b9797c2e10e7f5d456643d3b420cb"></a><!-- doxytag: member="gr_buffer_reader::gr_buffer_add_reader" ref="afb5b9797c2e10e7f5d456643d3b420cb" args="(gr_buffer_sptr buf, int nzero_preload, gr_block_sptr link)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> gr_buffer_add_reader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nzero_preload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> </td>
<td class="paramname"><em>link</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a> and attach it to buffer <code>buf</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>is the buffer the <code><a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a></code> reads from. </td></tr>
<tr><td class="paramname">nzero_preload</td><td>-- number of zero items to "preload" into buffer. </td></tr>
<tr><td class="paramname">link</td><td>is the block that reads from the buffer using this <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__buffer_8h_source.html">gr_buffer.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
711
