<!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: gr_buffer Class Reference</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('classgr__buffer.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classgr__buffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_buffer Class Reference<div class="ingroups"><a class="el" href="group__internal.html">Implementation Details</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Single writer, multiple reader fifo.
<a href="classgr__buffer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__buffer_8h_source.html">gr_buffer.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab3c5c8028b30a30c6c3eb3015225ba4b"><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 class="separator:ab3c5c8028b30a30c6c3eb3015225ba4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d064236bb139c339a425b51212813b1"><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 class="memdesc:a1d064236bb139c339a425b51212813b1"><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 class="separator:a1d064236bb139c339a425b51212813b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a2c75577d0b37f7eef0b930d588da4"><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 class="memdesc:a39a2c75577d0b37f7eef0b930d588da4"><td class="mdescLeft"> </td><td class="mdescRight">return size of this buffer in items <a href="#a39a2c75577d0b37f7eef0b930d588da4"></a><br/></td></tr>
<tr class="separator:a39a2c75577d0b37f7eef0b930d588da4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a4dc904e4da49e58a3405550665a712"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a1a4dc904e4da49e58a3405550665a712">write_pointer</a> ()</td></tr>
<tr class="memdesc:a1a4dc904e4da49e58a3405550665a712"><td class="mdescLeft"> </td><td class="mdescRight">return pointer to write buffer. <a href="#a1a4dc904e4da49e58a3405550665a712"></a><br/></td></tr>
<tr class="separator:a1a4dc904e4da49e58a3405550665a712"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba102b9c8394068b2c4b570c0e788e82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#aba102b9c8394068b2c4b570c0e788e82">update_write_pointer</a> (int nitems)</td></tr>
<tr class="memdesc:aba102b9c8394068b2c4b570c0e788e82"><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 class="separator:aba102b9c8394068b2c4b570c0e788e82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7528d62028e0b7e022734b00f8aeb1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#af7528d62028e0b7e022734b00f8aeb1b">set_done</a> (bool <a class="el" href="classgr__buffer.html#a89a1d9c85ba243e952a62015c7009d8d">done</a>)</td></tr>
<tr class="separator:af7528d62028e0b7e022734b00f8aeb1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89a1d9c85ba243e952a62015c7009d8d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a89a1d9c85ba243e952a62015c7009d8d">done</a> () const </td></tr>
<tr class="separator:a89a1d9c85ba243e952a62015c7009d8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e5c410222891cad5b7d5b85ff82b85f"><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 class="memdesc:a3e5c410222891cad5b7d5b85ff82b85f"><td class="mdescLeft"> </td><td class="mdescRight">Return the block that writes to this buffer. <a href="#a3e5c410222891cad5b7d5b85ff82b85f"></a><br/></td></tr>
<tr class="separator:a3e5c410222891cad5b7d5b85ff82b85f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2eb5af8306fe4a2c6d6838ff41b3240b"><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 class="separator:a2eb5af8306fe4a2c6d6838ff41b3240b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2009bf87ea09dd35abd0f42030911381"><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 class="separator:a2009bf87ea09dd35abd0f42030911381"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad55c520b62a7ebae0593f7c74fdba745"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#ad55c520b62a7ebae0593f7c74fdba745">mutex</a> ()</td></tr>
<tr class="separator:ad55c520b62a7ebae0593f7c74fdba745"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a024cd85cd041d18208b717d38cf67d0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a024cd85cd041d18208b717d38cf67d0c">nitems_written</a> ()</td></tr>
<tr class="separator:a024cd85cd041d18208b717d38cf67d0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a404f1dda059344e176e8e37e77525978"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a404f1dda059344e176e8e37e77525978">get_sizeof_item</a> ()</td></tr>
<tr class="separator:a404f1dda059344e176e8e37e77525978"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a616aa3e09d83804ea3d6045e4f7f5153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a616aa3e09d83804ea3d6045e4f7f5153">add_item_tag</a> (const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> &tag)</td></tr>
<tr class="memdesc:a616aa3e09d83804ea3d6045e4f7f5153"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new tag to the buffer. <a href="#a616aa3e09d83804ea3d6045e4f7f5153"></a><br/></td></tr>
<tr class="separator:a616aa3e09d83804ea3d6045e4f7f5153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88d6888e976e98fadf67a6e10f3809c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a88d6888e976e98fadf67a6e10f3809c2">remove_item_tag</a> (const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> &tag)</td></tr>
<tr class="memdesc:a88d6888e976e98fadf67a6e10f3809c2"><td class="mdescLeft"> </td><td class="mdescRight">Removes an existing tag from the buffer. <a href="#a88d6888e976e98fadf67a6e10f3809c2"></a><br/></td></tr>
<tr class="separator:a88d6888e976e98fadf67a6e10f3809c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c41b22bab8406fab93853f72b5151d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#a9c41b22bab8406fab93853f72b5151d4">prune_tags</a> (<a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> max_time)</td></tr>
<tr class="memdesc:a9c41b22bab8406fab93853f72b5151d4"><td class="mdescLeft"> </td><td class="mdescRight">Removes all tags before <code>max_time</code> from buffer. <a href="#a9c41b22bab8406fab93853f72b5151d4"></a><br/></td></tr>
<tr class="separator:a9c41b22bab8406fab93853f72b5151d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcc2b78e50b043782f070fb741b8e941"><td class="memItemLeft" align="right" valign="top">std::deque< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#adcc2b78e50b043782f070fb741b8e941">get_tags_begin</a> ()</td></tr>
<tr class="separator:adcc2b78e50b043782f070fb741b8e941"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaed6d72be9df4318038213bd3de747c3"><td class="memItemLeft" align="right" valign="top">std::deque< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer.html#aaed6d72be9df4318038213bd3de747c3">get_tags_end</a> ()</td></tr>
<tr class="separator:aaed6d72be9df4318038213bd3de747c3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a60aa2c93de67e9c5782a34130aac8da3"><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 class="separator:a60aa2c93de67e9c5782a34130aac8da3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ce1b319068ce94e4799b7affe4b48ae"><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 class="separator:a2ce1b319068ce94e4799b7affe4b48ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a7ecfad759b1fdf2dcb7416a16f563482"><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 class="separator:a7ecfad759b1fdf2dcb7416a16f563482"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7059abdea031e9dabb05114ddb8f7be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <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#ae7059abdea031e9dabb05114ddb8f7be">gr_make_buffer</a> (int nitems, size_t sizeof_item, <a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> <a class="el" href="classgr__buffer.html#a3e5c410222891cad5b7d5b85ff82b85f">link</a>)</td></tr>
<tr class="memdesc:ae7059abdea031e9dabb05114ddb8f7be"><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="#ae7059abdea031e9dabb05114ddb8f7be"></a><br/></td></tr>
<tr class="separator:ae7059abdea031e9dabb05114ddb8f7be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc1ca197033760254a594982fde1a4a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <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#adc1ca197033760254a594982fde1a4a0">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> <a class="el" href="classgr__buffer.html#a3e5c410222891cad5b7d5b85ff82b85f">link</a>)</td></tr>
<tr class="memdesc:adc1ca197033760254a594982fde1a4a0"><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="#adc1ca197033760254a594982fde1a4a0"></a><br/></td></tr>
<tr class="separator:adc1ca197033760254a594982fde1a4a0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single writer, multiple reader fifo. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab3c5c8028b30a30c6c3eb3015225ba4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual gr_buffer::~gr_buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a616aa3e09d83804ea3d6045e4f7f5153"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer::add_item_tag </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> & </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new tag to the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>the new tag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a39a2c75577d0b37f7eef0b930d588da4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gr_buffer::bufsize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return size of this buffer in items </p>
</div>
</div>
<a class="anchor" id="a89a1d9c85ba243e952a62015c7009d8d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gr_buffer::done </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a404f1dda059344e176e8e37e77525978"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t gr_buffer::get_sizeof_item </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adcc2b78e50b043782f070fb741b8e941"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::deque<<a class="el" href="structgr__tag__t.html">gr_tag_t</a>>::iterator gr_buffer::get_tags_begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aaed6d72be9df4318038213bd3de747c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::deque<<a class="el" href="structgr__tag__t.html">gr_tag_t</a>>::iterator gr_buffer::get_tags_end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3e5c410222891cad5b7d5b85ff82b85f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the block that writes to this buffer. </p>
</div>
</div>
<a class="anchor" id="ad55c520b62a7ebae0593f7c74fdba745"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a>* gr_buffer::mutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a024cd85cd041d18208b717d38cf67d0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> gr_buffer::nitems_written </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2eb5af8306fe4a2c6d6838ff41b3240b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t gr_buffer::nreaders </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c41b22bab8406fab93853f72b5151d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer::prune_tags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> </td>
<td class="paramname"><em>max_time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all tags before <code>max_time</code> from buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max_time</td><td>the time (item number) to trim up until. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2009bf87ea09dd35abd0f42030911381"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a88d6888e976e98fadf67a6e10f3809c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer::remove_item_tag </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> & </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes an existing tag from the buffer. </p>
<p>If no such tag is found, does nothing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>the tag that needs to be removed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af7528d62028e0b7e022734b00f8aeb1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer::set_done </td>
<td>(</td>
<td class="paramtype">bool </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>
<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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> 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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>* 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>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="adc1ca197033760254a594982fde1a4a0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </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 class="params"><dt>Parameters</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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7059abdea031e9dabb05114ddb8f7be"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </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 class="params"><dt>Parameters</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>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a60aa2c93de67e9c5782a34130aac8da3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char* gr_buffer::d_base</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2ce1b319068ce94e4799b7affe4b48ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int gr_buffer::d_bufsize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</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><!-- 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="classgr__buffer.html">gr_buffer</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:37 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>
