<!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 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.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="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_buffer 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" -->
<p>Single writer, multiple reader fifo.
<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-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 boost::unique_lock<br class="typebreak"/>
< boost::mutex > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#aff98726da27f70ef316640f925636260">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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#ab3c5c8028b30a30c6c3eb3015225ba4b">~gr_buffer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a1d064236bb139c339a425b51212813b1">space_available</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return number of items worth of space available for writing <a href="#a1d064236bb139c339a425b51212813b1"></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.html#a39a2c75577d0b37f7eef0b930d588da4">bufsize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return size of this buffer in items <a href="#a39a2c75577d0b37f7eef0b930d588da4"></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.html#a1a4dc904e4da49e58a3405550665a712">write_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return pointer to write buffer. <a href="#a1a4dc904e4da49e58a3405550665a712"></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.html#aba102b9c8394068b2c4b570c0e788e82">update_write_pointer</a> (int nitems)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">tell buffer that we wrote <code>nitems</code> into it <a href="#aba102b9c8394068b2c4b570c0e788e82"></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.html#af7528d62028e0b7e022734b00f8aeb1b">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.html#a89a1d9c85ba243e952a62015c7009d8d">done</a> () const </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.html#a3e5c410222891cad5b7d5b85ff82b85f">link</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the block that writes to this buffer. <a href="#a3e5c410222891cad5b7d5b85ff82b85f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a2eb5af8306fe4a2c6d6838ff41b3240b">nreaders</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a2009bf87ea09dd35abd0f42030911381">reader</a> (size_t index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boost::mutex * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#afb6b8a5f64a9d556a80ce528168fcd7b">mutex</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a60aa2c93de67e9c5782a34130aac8da3">d_base</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a2ce1b319068ce94e4799b7affe4b48ae">d_bufsize</a></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.html#a7ecfad759b1fdf2dcb7416a16f563482">gr_buffer_reader</a></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.html#a9c3543ee3c4e4eea1d8ea5c3705ecdbf">gr_make_buffer</a> (int nitems, size_t sizeof_item, <a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> link)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a buffer that holds at least <code>nitems</code> of size <code>sizeof_item</code>. <a href="#a9c3543ee3c4e4eea1d8ea5c3705ecdbf"></a><br/></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.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>Single writer, multiple reader fifo. </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aff98726da27f70ef316640f925636260"></a><!-- doxytag: member="gr_buffer::scoped_lock" ref="aff98726da27f70ef316640f925636260" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::unique_lock<boost::mutex> <a class="el" href="classgr__buffer.html#aff98726da27f70ef316640f925636260">gr_buffer::scoped_lock</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab3c5c8028b30a30c6c3eb3015225ba4b"></a><!-- doxytag: member="gr_buffer::~gr_buffer" ref="ab3c5c8028b30a30c6c3eb3015225ba4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_buffer::~gr_buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a39a2c75577d0b37f7eef0b930d588da4"></a><!-- doxytag: member="gr_buffer::bufsize" ref="a39a2c75577d0b37f7eef0b930d588da4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_buffer::bufsize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return size of this buffer in items </p>
<p>References <a class="el" href="classgr__buffer.html#a2ce1b319068ce94e4799b7affe4b48ae">d_bufsize</a>.</p>
</div>
</div>
<a class="anchor" id="a89a1d9c85ba243e952a62015c7009d8d"></a><!-- doxytag: member="gr_buffer::done" ref="a89a1d9c85ba243e952a62015c7009d8d" 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::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="a3e5c410222891cad5b7d5b85ff82b85f"></a><!-- doxytag: member="gr_buffer::link" ref="a3e5c410222891cad5b7d5b85ff82b85f" 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::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 writes to this buffer. </p>
</div>
</div>
<a class="anchor" id="afb6b8a5f64a9d556a80ce528168fcd7b"></a><!-- doxytag: member="gr_buffer::mutex" ref="afb6b8a5f64a9d556a80ce528168fcd7b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::mutex* gr_buffer::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="a2eb5af8306fe4a2c6d6838ff41b3240b"></a><!-- doxytag: member="gr_buffer::nreaders" ref="a2eb5af8306fe4a2c6d6838ff41b3240b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t gr_buffer::nreaders </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="a2009bf87ea09dd35abd0f42030911381"></a><!-- doxytag: member="gr_buffer::reader" ref="a2009bf87ea09dd35abd0f42030911381" args="(size_t index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</a>* gr_buffer::reader </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af7528d62028e0b7e022734b00f8aeb1b"></a><!-- doxytag: member="gr_buffer::set_done" ref="af7528d62028e0b7e022734b00f8aeb1b" args="(bool done)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_buffer::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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1d064236bb139c339a425b51212813b1"></a><!-- doxytag: member="gr_buffer::space_available" ref="a1d064236bb139c339a425b51212813b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_buffer::space_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return number of items worth of space available for writing </p>
</div>
</div>
<a class="anchor" id="aba102b9c8394068b2c4b570c0e788e82"></a><!-- doxytag: member="gr_buffer::update_write_pointer" ref="aba102b9c8394068b2c4b570c0e788e82" args="(int nitems)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_buffer::update_write_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">
<p>tell buffer that we wrote <code>nitems</code> into it </p>
</div>
</div>
<a class="anchor" id="a1a4dc904e4da49e58a3405550665a712"></a><!-- doxytag: member="gr_buffer::write_pointer" ref="a1a4dc904e4da49e58a3405550665a712" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* gr_buffer::write_pointer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return pointer to write buffer. </p>
<p>The return value points at space that can hold at least <a class="el" href="classgr__buffer.html#a1d064236bb139c339a425b51212813b1" title="return number of items worth of space available for writing">space_available()</a> items. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="afb5b9797c2e10e7f5d456643d3b420cb"></a><!-- doxytag: member="gr_buffer::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>
<a class="anchor" id="a7ecfad759b1fdf2dcb7416a16f563482"></a><!-- doxytag: member="gr_buffer::gr_buffer_reader" ref="a7ecfad759b1fdf2dcb7416a16f563482" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c3543ee3c4e4eea1d8ea5c3705ecdbf"></a><!-- doxytag: member="gr_buffer::gr_make_buffer" ref="a9c3543ee3c4e4eea1d8ea5c3705ecdbf" args="(int nitems, size_t sizeof_item, 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_sptr</a> gr_make_buffer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>nitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sizeof_item</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>Allocate a buffer that holds at least <code>nitems</code> of size <code>sizeof_item</code>. </p>
<p>The total size of the buffer will be rounded up to a system dependent boundary. This is typically the system page size, but under MS windows is 64KB.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">nitems</td><td>is the minimum number of items the buffer will hold. </td></tr>
<tr><td class="paramname">sizeof_item</td><td>is the size of an item in bytes. </td></tr>
<tr><td class="paramname">link</td><td>is the block that writes to this buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a60aa2c93de67e9c5782a34130aac8da3"></a><!-- doxytag: member="gr_buffer::d_base" ref="a60aa2c93de67e9c5782a34130aac8da3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classgr__buffer.html#a60aa2c93de67e9c5782a34130aac8da3">gr_buffer::d_base</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2ce1b319068ce94e4799b7affe4b48ae"></a><!-- doxytag: member="gr_buffer::d_bufsize" ref="a2ce1b319068ce94e4799b7affe4b48ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="classgr__buffer.html#a2ce1b319068ce94e4799b7affe4b48ae">gr_buffer::d_bufsize</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__buffer.html#a39a2c75577d0b37f7eef0b930d588da4">bufsize()</a>.</p>
</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.html">gr_buffer</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>
