mirror of https://github.com/hmatuschek/libsdr
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
624 lines
43 KiB
HTML
624 lines
43 KiB
HTML
<!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.9.1"/>
|
|
<title>libsdr: sdr::RawRingBuffer 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">libsdr
|
|
 <span id="projectnumber">0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">A simple SDR library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classsdr_1_1_raw_ring_buffer-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sdr::RawRingBuffer Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A simple ring buffer.
|
|
<a href="classsdr_1_1_raw_ring_buffer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="buffer_8hh_source.html">buffer.hh</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sdr::RawRingBuffer:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsdr_1_1_raw_ring_buffer.png" usemap="#sdr::RawRingBuffer_map" alt=""/>
|
|
<map id="sdr::RawRingBuffer_map" name="sdr::RawRingBuffer_map">
|
|
<area href="classsdr_1_1_raw_buffer.html" title="Base class of all buffers, represents an untyped array of bytes. " alt="sdr::RawBuffer" shape="rect" coords="0,0,157,24"/>
|
|
<area href="classsdr_1_1_ring_buffer.html" title="A simple typed ring-buffer. " alt="sdr::RingBuffer< Scalar >" shape="rect" coords="0,112,157,136"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a079ead1956aece8f0d4d50b852362f1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a079ead1956aece8f0d4d50b852362f1e">RawRingBuffer</a> ()</td></tr>
|
|
<tr class="memdesc:a079ead1956aece8f0d4d50b852362f1e"><td class="mdescLeft"> </td><td class="mdescRight">Empty constructor. <a href="#a079ead1956aece8f0d4d50b852362f1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a079ead1956aece8f0d4d50b852362f1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55bb852e46dbb192651048e8ca1426e4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a55bb852e46dbb192651048e8ca1426e4">RawRingBuffer</a> (size_t size)</td></tr>
|
|
<tr class="memdesc:a55bb852e46dbb192651048e8ca1426e4"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a raw ring buffer with size <code>size</code>. <a href="#a55bb852e46dbb192651048e8ca1426e4">More...</a><br /></td></tr>
|
|
<tr class="separator:a55bb852e46dbb192651048e8ca1426e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae49387c3f41d2f8674ab8664f9adb52"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#aae49387c3f41d2f8674ab8664f9adb52">RawRingBuffer</a> (const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a> &other)</td></tr>
|
|
<tr class="memdesc:aae49387c3f41d2f8674ab8664f9adb52"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#aae49387c3f41d2f8674ab8664f9adb52">More...</a><br /></td></tr>
|
|
<tr class="separator:aae49387c3f41d2f8674ab8664f9adb52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fe52e281ce0c4ec90c04ae16b37dd75"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a1fe52e281ce0c4ec90c04ae16b37dd75">~RawRingBuffer</a> ()</td></tr>
|
|
<tr class="memdesc:a1fe52e281ce0c4ec90c04ae16b37dd75"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a1fe52e281ce0c4ec90c04ae16b37dd75">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fe52e281ce0c4ec90c04ae16b37dd75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2e14fbe4f6e22e04e55f7ab930d3f52"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#ad2e14fbe4f6e22e04e55f7ab930d3f52">operator=</a> (const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a> &other)</td></tr>
|
|
<tr class="memdesc:ad2e14fbe4f6e22e04e55f7ab930d3f52"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator, turns this ring buffer into a reference to the other one. <a href="#ad2e14fbe4f6e22e04e55f7ab930d3f52">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2e14fbe4f6e22e04e55f7ab930d3f52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a622446adcd06185c645f94dfc4f8b457"><td class="memItemLeft" align="right" valign="top">char & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a622446adcd06185c645f94dfc4f8b457">operator[]</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a622446adcd06185c645f94dfc4f8b457"><td class="mdescLeft"> </td><td class="mdescRight">Element access. <a href="#a622446adcd06185c645f94dfc4f8b457">More...</a><br /></td></tr>
|
|
<tr class="separator:a622446adcd06185c645f94dfc4f8b457"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27378a9c8969562b6eac2bcf20e3adb0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a27378a9c8969562b6eac2bcf20e3adb0">bytesLen</a> () const </td></tr>
|
|
<tr class="memdesc:a27378a9c8969562b6eac2bcf20e3adb0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes available for reading. <a href="#a27378a9c8969562b6eac2bcf20e3adb0">More...</a><br /></td></tr>
|
|
<tr class="separator:a27378a9c8969562b6eac2bcf20e3adb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f9a5fc51e9dd149230cac3310bf9671"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a5f9a5fc51e9dd149230cac3310bf9671">bytesFree</a> () const </td></tr>
|
|
<tr class="memdesc:a5f9a5fc51e9dd149230cac3310bf9671"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of free bytes in the ring buffer. <a href="#a5f9a5fc51e9dd149230cac3310bf9671">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f9a5fc51e9dd149230cac3310bf9671"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd4071b19ead6aea6a8903ada1e1e54a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#afd4071b19ead6aea6a8903ada1e1e54a">put</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &src)</td></tr>
|
|
<tr class="memdesc:afd4071b19ead6aea6a8903ada1e1e54a"><td class="mdescLeft"> </td><td class="mdescRight">Puts the given data into the ring-buffer. <a href="#afd4071b19ead6aea6a8903ada1e1e54a">More...</a><br /></td></tr>
|
|
<tr class="separator:afd4071b19ead6aea6a8903ada1e1e54a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8847c1cbdf39ab61a1f8d0f752d7e5b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a8847c1cbdf39ab61a1f8d0f752d7e5b1">take</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &dest, size_t N)</td></tr>
|
|
<tr class="memdesc:a8847c1cbdf39ab61a1f8d0f752d7e5b1"><td class="mdescLeft"> </td><td class="mdescRight">Take <code>N</code> bytes from the ring buffer and store it into the given buffer <code>dest</code>. <a href="#a8847c1cbdf39ab61a1f8d0f752d7e5b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a8847c1cbdf39ab61a1f8d0f752d7e5b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fbec40ea5cced229b49103b0ef73001"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a5fbec40ea5cced229b49103b0ef73001">drop</a> (size_t N)</td></tr>
|
|
<tr class="memdesc:a5fbec40ea5cced229b49103b0ef73001"><td class="mdescLeft"> </td><td class="mdescRight">Drops at most <code>N</code> bytes from the buffer. <a href="#a5fbec40ea5cced229b49103b0ef73001">More...</a><br /></td></tr>
|
|
<tr class="separator:a5fbec40ea5cced229b49103b0ef73001"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8afcb27e77eb4ea0ffe7f615e610e9b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a8afcb27e77eb4ea0ffe7f615e610e9b9">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a8afcb27e77eb4ea0ffe7f615e610e9b9"><td class="mdescLeft"> </td><td class="mdescRight">Clear the ring-buffer. <a href="#a8afcb27e77eb4ea0ffe7f615e610e9b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a8afcb27e77eb4ea0ffe7f615e610e9b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9afdf7bcc99f4f4f0ef76ae7e6e5ae40"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a9afdf7bcc99f4f4f0ef76ae7e6e5ae40">resize</a> (size_t N)</td></tr>
|
|
<tr class="memdesc:a9afdf7bcc99f4f4f0ef76ae7e6e5ae40"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the ring buffer. <a href="#a9afdf7bcc99f4f4f0ef76ae7e6e5ae40">More...</a><br /></td></tr>
|
|
<tr class="separator:a9afdf7bcc99f4f4f0ef76ae7e6e5ae40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classsdr_1_1_raw_buffer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_raw_buffer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsdr_1_1_raw_buffer.html">sdr::RawBuffer</a></td></tr>
|
|
<tr class="memitem:a781495d421a8cb4fcf27b0e422a3b432 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a781495d421a8cb4fcf27b0e422a3b432">RawBuffer</a> ()</td></tr>
|
|
<tr class="memdesc:a781495d421a8cb4fcf27b0e422a3b432 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty buffer. <a href="#a781495d421a8cb4fcf27b0e422a3b432">More...</a><br /></td></tr>
|
|
<tr class="separator:a781495d421a8cb4fcf27b0e422a3b432 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad55ada4bd5b86ea232000360e4e7da38 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#ad55ada4bd5b86ea232000360e4e7da38">RawBuffer</a> (char *<a class="el" href="classsdr_1_1_raw_buffer.html#a41429fafa5acac7eb6ab22001fedc3d7">data</a>, size_t offset, size_t len)</td></tr>
|
|
<tr class="memdesc:ad55ada4bd5b86ea232000360e4e7da38 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Constructor from unowned data. <a href="#ad55ada4bd5b86ea232000360e4e7da38">More...</a><br /></td></tr>
|
|
<tr class="separator:ad55ada4bd5b86ea232000360e4e7da38 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17f8bfebc44cfff6e77af7d6fefdbbe5 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a17f8bfebc44cfff6e77af7d6fefdbbe5">RawBuffer</a> (size_t N, <a class="el" href="classsdr_1_1_buffer_owner.html">BufferOwner</a> *owner=0)</td></tr>
|
|
<tr class="memdesc:a17f8bfebc44cfff6e77af7d6fefdbbe5 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a buffer and allocates N bytes. <a href="#a17f8bfebc44cfff6e77af7d6fefdbbe5">More...</a><br /></td></tr>
|
|
<tr class="separator:a17f8bfebc44cfff6e77af7d6fefdbbe5 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a534d87f7eac95b2f9d912e3f7c509d47 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a534d87f7eac95b2f9d912e3f7c509d47">RawBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &other)</td></tr>
|
|
<tr class="memdesc:a534d87f7eac95b2f9d912e3f7c509d47 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a534d87f7eac95b2f9d912e3f7c509d47">More...</a><br /></td></tr>
|
|
<tr class="separator:a534d87f7eac95b2f9d912e3f7c509d47 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a274ca58a73c0b27bc23b440e8cc693bf inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a274ca58a73c0b27bc23b440e8cc693bf">RawBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &other, size_t offset, size_t len)</td></tr>
|
|
<tr class="memdesc:a274ca58a73c0b27bc23b440e8cc693bf inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new view on the buffer. <a href="#a274ca58a73c0b27bc23b440e8cc693bf">More...</a><br /></td></tr>
|
|
<tr class="separator:a274ca58a73c0b27bc23b440e8cc693bf inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa665641793e5fd0f036f0ec66d943c08 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#aa665641793e5fd0f036f0ec66d943c08">~RawBuffer</a> ()</td></tr>
|
|
<tr class="memdesc:aa665641793e5fd0f036f0ec66d943c08 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa665641793e5fd0f036f0ec66d943c08">More...</a><br /></td></tr>
|
|
<tr class="separator:aa665641793e5fd0f036f0ec66d943c08 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1723264fc54a81fcb90e640b296a2e6 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#ad1723264fc54a81fcb90e640b296a2e6">operator=</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &other)</td></tr>
|
|
<tr class="memdesc:ad1723264fc54a81fcb90e640b296a2e6 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <a href="#ad1723264fc54a81fcb90e640b296a2e6">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1723264fc54a81fcb90e640b296a2e6 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2384e82c2344e55b0246e8aebcd713f2 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a2384e82c2344e55b0246e8aebcd713f2">ptr</a> () const </td></tr>
|
|
<tr class="memdesc:a2384e82c2344e55b0246e8aebcd713f2 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the data (w/o view). <a href="#a2384e82c2344e55b0246e8aebcd713f2">More...</a><br /></td></tr>
|
|
<tr class="separator:a2384e82c2344e55b0246e8aebcd713f2 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41429fafa5acac7eb6ab22001fedc3d7 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a41429fafa5acac7eb6ab22001fedc3d7">data</a> () const </td></tr>
|
|
<tr class="memdesc:a41429fafa5acac7eb6ab22001fedc3d7 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the data of the buffer view. <a href="#a41429fafa5acac7eb6ab22001fedc3d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a41429fafa5acac7eb6ab22001fedc3d7 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71f6b914f5919bc4403f93bab28798a8 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a71f6b914f5919bc4403f93bab28798a8">bytesOffset</a> () const </td></tr>
|
|
<tr class="memdesc:a71f6b914f5919bc4403f93bab28798a8 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offset of the data by the view. <a href="#a71f6b914f5919bc4403f93bab28798a8">More...</a><br /></td></tr>
|
|
<tr class="separator:a71f6b914f5919bc4403f93bab28798a8 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a822092fbdd5957035d89b7a958fd1f67 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a822092fbdd5957035d89b7a958fd1f67">bytesLen</a> () const </td></tr>
|
|
<tr class="memdesc:a822092fbdd5957035d89b7a958fd1f67 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the buffer by the view. <a href="#a822092fbdd5957035d89b7a958fd1f67">More...</a><br /></td></tr>
|
|
<tr class="separator:a822092fbdd5957035d89b7a958fd1f67 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51e97f8beeacd8734fdb347af02ee215 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a51e97f8beeacd8734fdb347af02ee215">storageSize</a> () const </td></tr>
|
|
<tr class="memdesc:a51e97f8beeacd8734fdb347af02ee215 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw buffer size in bytes. <a href="#a51e97f8beeacd8734fdb347af02ee215">More...</a><br /></td></tr>
|
|
<tr class="separator:a51e97f8beeacd8734fdb347af02ee215 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a944346de6bb972f687716bee921a3bad inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a944346de6bb972f687716bee921a3bad">isEmpty</a> () const </td></tr>
|
|
<tr class="memdesc:a944346de6bb972f687716bee921a3bad inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the buffer is invalid/empty. <a href="#a944346de6bb972f687716bee921a3bad">More...</a><br /></td></tr>
|
|
<tr class="separator:a944346de6bb972f687716bee921a3bad inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45139d21c4bb6df7c664720223ea3540 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a45139d21c4bb6df7c664720223ea3540">ref</a> () const </td></tr>
|
|
<tr class="memdesc:a45139d21c4bb6df7c664720223ea3540 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Increment reference counter. <a href="#a45139d21c4bb6df7c664720223ea3540">More...</a><br /></td></tr>
|
|
<tr class="separator:a45139d21c4bb6df7c664720223ea3540 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ffd3cbf476c9036bfada9ae8c7c5e05 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a8ffd3cbf476c9036bfada9ae8c7c5e05">unref</a> ()</td></tr>
|
|
<tr class="memdesc:a8ffd3cbf476c9036bfada9ae8c7c5e05 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Dereferences the buffer. <a href="#a8ffd3cbf476c9036bfada9ae8c7c5e05">More...</a><br /></td></tr>
|
|
<tr class="separator:a8ffd3cbf476c9036bfada9ae8c7c5e05 inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6079ff8999d3878071d6308312e063a inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#ab6079ff8999d3878071d6308312e063a">refCount</a> () const </td></tr>
|
|
<tr class="memdesc:ab6079ff8999d3878071d6308312e063a inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference counter. <a href="#ab6079ff8999d3878071d6308312e063a">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6079ff8999d3878071d6308312e063a inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2f4ac2dc396108141ec8473bfb7f99a inherit pub_methods_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#ab2f4ac2dc396108141ec8473bfb7f99a">isUnused</a> () const </td></tr>
|
|
<tr class="memdesc:ab2f4ac2dc396108141ec8473bfb7f99a inherit pub_methods_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">We assume here that buffers are owned by one object: A buffer is therefore "unused" if the owner holds the only reference to the buffer. <a href="#ab2f4ac2dc396108141ec8473bfb7f99a">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2f4ac2dc396108141ec8473bfb7f99a inherit pub_methods_classsdr_1_1_raw_buffer"><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:a62b8711073973314e044e52607eeed6a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#a62b8711073973314e044e52607eeed6a">_take_idx</a></td></tr>
|
|
<tr class="memdesc:a62b8711073973314e044e52607eeed6a"><td class="mdescLeft"> </td><td class="mdescRight">The current read pointer. <a href="#a62b8711073973314e044e52607eeed6a">More...</a><br /></td></tr>
|
|
<tr class="separator:a62b8711073973314e044e52607eeed6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa83b365b78b6a2e4a4f05169685b80c2"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_ring_buffer.html#aa83b365b78b6a2e4a4f05169685b80c2">_b_stored</a></td></tr>
|
|
<tr class="memdesc:aa83b365b78b6a2e4a4f05169685b80c2"><td class="mdescLeft"> </td><td class="mdescRight">Offset of the write pointer relative to the <code>_take_idx</code> ptr, such that the number of stored bytes is <code>_b_stored</code> and the write index is (_take_idx+_b_stored) % _storage_size. <a href="#aa83b365b78b6a2e4a4f05169685b80c2">More...</a><br /></td></tr>
|
|
<tr class="separator:aa83b365b78b6a2e4a4f05169685b80c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classsdr_1_1_raw_buffer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsdr_1_1_raw_buffer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsdr_1_1_raw_buffer.html">sdr::RawBuffer</a></td></tr>
|
|
<tr class="memitem:add2d96bdd2f1d7229c980a20b388e4dd inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#add2d96bdd2f1d7229c980a20b388e4dd">_ptr</a></td></tr>
|
|
<tr class="memdesc:add2d96bdd2f1d7229c980a20b388e4dd inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Holds the pointer to the data or 0, if buffer is empty. <a href="#add2d96bdd2f1d7229c980a20b388e4dd">More...</a><br /></td></tr>
|
|
<tr class="separator:add2d96bdd2f1d7229c980a20b388e4dd inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a101a2f2a11976504d8782b8e952f289d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a101a2f2a11976504d8782b8e952f289d">_storage_size</a></td></tr>
|
|
<tr class="memdesc:a101a2f2a11976504d8782b8e952f289d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Holds the size of the buffer in bytes. <a href="#a101a2f2a11976504d8782b8e952f289d">More...</a><br /></td></tr>
|
|
<tr class="separator:a101a2f2a11976504d8782b8e952f289d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ff93265c612917548b5b9e27e729c83 inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a4ff93265c612917548b5b9e27e729c83">_b_offset</a></td></tr>
|
|
<tr class="memdesc:a4ff93265c612917548b5b9e27e729c83 inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Holds the offset of the buffer in bytes. <a href="#a4ff93265c612917548b5b9e27e729c83">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ff93265c612917548b5b9e27e729c83 inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa14cbd626cb63e4fffc080ddbe14120d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#aa14cbd626cb63e4fffc080ddbe14120d">_b_length</a></td></tr>
|
|
<tr class="memdesc:aa14cbd626cb63e4fffc080ddbe14120d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Holds the length of the buffer (view) in bytes. <a href="#aa14cbd626cb63e4fffc080ddbe14120d">More...</a><br /></td></tr>
|
|
<tr class="separator:aa14cbd626cb63e4fffc080ddbe14120d inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb345679b48051ba741887b194e93c1c inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#abb345679b48051ba741887b194e93c1c">_refcount</a></td></tr>
|
|
<tr class="memdesc:abb345679b48051ba741887b194e93c1c inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">The reference counter. <a href="#abb345679b48051ba741887b194e93c1c">More...</a><br /></td></tr>
|
|
<tr class="separator:abb345679b48051ba741887b194e93c1c inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3127de65087a2e2260d53c28616089bc inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_buffer_owner.html">BufferOwner</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_raw_buffer.html#a3127de65087a2e2260d53c28616089bc">_owner</a></td></tr>
|
|
<tr class="memdesc:a3127de65087a2e2260d53c28616089bc inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Holds a weak reference the buffer owner. <a href="#a3127de65087a2e2260d53c28616089bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a3127de65087a2e2260d53c28616089bc inherit pro_attribs_classsdr_1_1_raw_buffer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A simple ring buffer. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a079ead1956aece8f0d4d50b852362f1e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RawRingBuffer::RawRingBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Empty constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a55bb852e46dbb192651048e8ca1426e4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RawRingBuffer::RawRingBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a raw ring buffer with size <code>size</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aae49387c3f41d2f8674ab8664f9adb52"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RawRingBuffer::RawRingBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1fe52e281ce0c4ec90c04ae16b37dd75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RawRingBuffer::~RawRingBuffer </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">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a5f9a5fc51e9dd149230cac3310bf9671"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t sdr::RawRingBuffer::bytesFree </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>Returns the number of free bytes in the ring buffer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a27378a9c8969562b6eac2bcf20e3adb0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t sdr::RawRingBuffer::bytesLen </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>Returns the number of bytes available for reading. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8afcb27e77eb4ea0ffe7f615e610e9b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sdr::RawRingBuffer::clear </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>Clear the ring-buffer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5fbec40ea5cced229b49103b0ef73001"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sdr::RawRingBuffer::drop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>N</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">
|
|
|
|
<p>Drops at most <code>N</code> bytes from the buffer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad2e14fbe4f6e22e04e55f7ab930d3f52"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a>& sdr::RawRingBuffer::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_ring_buffer.html">RawRingBuffer</a> & </td>
|
|
<td class="paramname"><em>other</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">
|
|
|
|
<p>Assignment operator, turns this ring buffer into a reference to the other one. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a622446adcd06185c645f94dfc4f8b457"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char& sdr::RawRingBuffer::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>idx</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">
|
|
|
|
<p>Element access. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afd4071b19ead6aea6a8903ada1e1e54a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdr::RawRingBuffer::put </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> & </td>
|
|
<td class="paramname"><em>src</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">
|
|
|
|
<p>Puts the given data into the ring-buffer. </p>
|
|
<p>The size of <code>src</code> must be smaller or equal to the number of free bytes. Returns <code>true</code> if the data was written successfully to the buffer. </p>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Allow overwrite </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9afdf7bcc99f4f4f0ef76ae7e6e5ae40"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sdr::RawRingBuffer::resize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>N</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">
|
|
|
|
<p>Resizes the ring buffer. </p>
|
|
<p>Also clears it. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8847c1cbdf39ab61a1f8d0f752d7e5b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdr::RawRingBuffer::take </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> & </td>
|
|
<td class="paramname"><em>dest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>N</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Take <code>N</code> bytes from the ring buffer and store it into the given buffer <code>dest</code>. </p>
|
|
<p>Returns <code>true</code> if the data was taken successfully from the ring buffer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="aa83b365b78b6a2e4a4f05169685b80c2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t sdr::RawRingBuffer::_b_stored</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Offset of the write pointer relative to the <code>_take_idx</code> ptr, such that the number of stored bytes is <code>_b_stored</code> and the write index is (_take_idx+_b_stored) % _storage_size. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a62b8711073973314e044e52607eeed6a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t sdr::RawRingBuffer::_take_idx</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The current read pointer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="buffer_8hh_source.html">buffer.hh</a></li>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/buffer.cc</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 2 2015 18:28:39 for libsdr by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|