stdex/classstdex_1_1ring.html

317 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::ring&lt; T, N_cap &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1ring.html">ring</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1ring-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::ring&lt; T, N_cap &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Ring buffer.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ring_8hpp_source.html">stdex/ring.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a758a2e9010d402e3eb6114b70cfa095e" id="r_a758a2e9010d402e3eb6114b70cfa095e"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a758a2e9010d402e3eb6114b70cfa095e">back</a> ()</td></tr>
<tr class="memdesc:a758a2e9010d402e3eb6114b70cfa095e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates the data after the ring tail. Use <a class="el" href="#ad92cabdc54343abd20c2c1603effb1af" title="Notifies the receiver the data was populated.">push()</a> after the allocated data is populated. <br /></td></tr>
<tr class="separator:a758a2e9010d402e3eb6114b70cfa095e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad92cabdc54343abd20c2c1603effb1af" id="r_ad92cabdc54343abd20c2c1603effb1af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad92cabdc54343abd20c2c1603effb1af">push</a> (size_t size)</td></tr>
<tr class="memdesc:ad92cabdc54343abd20c2c1603effb1af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the receiver the data was populated. <br /></td></tr>
<tr class="separator:ad92cabdc54343abd20c2c1603effb1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad49cdfeb722bc80d51ba1db7e53e9366" id="r_ad49cdfeb722bc80d51ba1db7e53e9366"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad49cdfeb722bc80d51ba1db7e53e9366">front</a> ()</td></tr>
<tr class="memdesc:ad49cdfeb722bc80d51ba1db7e53e9366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peeks the data at the ring head. Use <a class="el" href="#a404fe1f77852c304206369546695b566" title="Notifies the sender the data was consumed.">pop()</a> after the data was consumed. <br /></td></tr>
<tr class="separator:ad49cdfeb722bc80d51ba1db7e53e9366"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a404fe1f77852c304206369546695b566" id="r_a404fe1f77852c304206369546695b566"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a404fe1f77852c304206369546695b566">pop</a> (size_t size)</td></tr>
<tr class="memdesc:a404fe1f77852c304206369546695b566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the sender the data was consumed. <br /></td></tr>
<tr class="separator:a404fe1f77852c304206369546695b566"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b06a04256d3ba57818f04adc54af72c" id="r_a8b06a04256d3ba57818f04adc54af72c"><td class="memItemLeft" align="right" valign="top"><a id="a8b06a04256d3ba57818f04adc54af72c" name="a8b06a04256d3ba57818f04adc54af72c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>quit</b> ()</td></tr>
<tr class="memdesc:a8b06a04256d3ba57818f04adc54af72c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancells waiting sender and receiver. <br /></td></tr>
<tr class="separator:a8b06a04256d3ba57818f04adc54af72c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2c895c0664cdcfc156e5a9fa42b30c3" id="r_af2c895c0664cdcfc156e5a9fa42b30c3"><td class="memItemLeft" align="right" valign="top"><a id="af2c895c0664cdcfc156e5a9fa42b30c3" name="af2c895c0664cdcfc156e5a9fa42b30c3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>sync</b> ()</td></tr>
<tr class="memdesc:af2c895c0664cdcfc156e5a9fa42b30c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits until the ring is flush. <br /></td></tr>
<tr class="separator:af2c895c0664cdcfc156e5a9fa42b30c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9c1d30e3ab078bf928d8c54a88c3c012" id="r_a9c1d30e3ab078bf928d8c54a88c3c012"><td class="memItemLeft" align="right" valign="top"><a id="a9c1d30e3ab078bf928d8c54a88c3c012" name="a9c1d30e3ab078bf928d8c54a88c3c012"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>wrap</b> (size_t idx) const</td></tr>
<tr class="separator:a9c1d30e3ab078bf928d8c54a88c3c012"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52193f02910ec35e13a021432b3f51b9" id="r_a52193f02910ec35e13a021432b3f51b9"><td class="memItemLeft" align="right" valign="top"><a id="a52193f02910ec35e13a021432b3f51b9" name="a52193f02910ec35e13a021432b3f51b9"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>space</b> () const</td></tr>
<tr class="separator:a52193f02910ec35e13a021432b3f51b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35bfd052c7c2b319afd280b9071bb6ae" id="r_a35bfd052c7c2b319afd280b9071bb6ae"><td class="memItemLeft" align="right" valign="top"><a id="a35bfd052c7c2b319afd280b9071bb6ae" name="a35bfd052c7c2b319afd280b9071bb6ae"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="separator:a35bfd052c7c2b319afd280b9071bb6ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a56e96c343a554e30b3ef5b60db8709d9" id="r_a56e96c343a554e30b3ef5b60db8709d9"><td class="memItemLeft" align="right" valign="top"><a id="a56e96c343a554e30b3ef5b60db8709d9" name="a56e96c343a554e30b3ef5b60db8709d9"></a>
std::mutex&#160;</td><td class="memItemRight" valign="bottom"><b>m_mutex</b></td></tr>
<tr class="separator:a56e96c343a554e30b3ef5b60db8709d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c1e774f4dd4fa8c18478875eb2a9f4a" id="r_a2c1e774f4dd4fa8c18478875eb2a9f4a"><td class="memItemLeft" align="right" valign="top"><a id="a2c1e774f4dd4fa8c18478875eb2a9f4a" name="a2c1e774f4dd4fa8c18478875eb2a9f4a"></a>
std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><b>m_head_moved</b></td></tr>
<tr class="separator:a2c1e774f4dd4fa8c18478875eb2a9f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d9ad18986001b92cf0b69f893826607" id="r_a7d9ad18986001b92cf0b69f893826607"><td class="memItemLeft" align="right" valign="top"><a id="a7d9ad18986001b92cf0b69f893826607" name="a7d9ad18986001b92cf0b69f893826607"></a>
std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><b>m_tail_moved</b></td></tr>
<tr class="separator:a7d9ad18986001b92cf0b69f893826607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7892072b2e33fa4a3d7c1850b4804f91" id="r_a7892072b2e33fa4a3d7c1850b4804f91"><td class="memItemLeft" align="right" valign="top"><a id="a7892072b2e33fa4a3d7c1850b4804f91" name="a7892072b2e33fa4a3d7c1850b4804f91"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_head</b></td></tr>
<tr class="separator:a7892072b2e33fa4a3d7c1850b4804f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8db6e54da23cda00029131613d1bff6e" id="r_a8db6e54da23cda00029131613d1bff6e"><td class="memItemLeft" align="right" valign="top"><a id="a8db6e54da23cda00029131613d1bff6e" name="a8db6e54da23cda00029131613d1bff6e"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_size</b></td></tr>
<tr class="separator:a8db6e54da23cda00029131613d1bff6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8942adf5efd39f57598135fd42de754e" id="r_a8942adf5efd39f57598135fd42de754e"><td class="memItemLeft" align="right" valign="top"><a id="a8942adf5efd39f57598135fd42de754e" name="a8942adf5efd39f57598135fd42de754e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_quit</b></td></tr>
<tr class="separator:a8942adf5efd39f57598135fd42de754e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78d74ad0cb3af342a4537a648a40f422" id="r_a78d74ad0cb3af342a4537a648a40f422"><td class="memItemLeft" align="right" valign="top"><a id="a78d74ad0cb3af342a4537a648a40f422" name="a78d74ad0cb3af342a4537a648a40f422"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_data</b> [N_cap]</td></tr>
<tr class="separator:a78d74ad0cb3af342a4537a648a40f422"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T, size_t N_cap&gt;<br />
class stdex::ring&lt; T, N_cap &gt;</div><p>Ring buffer. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Ring element type </td></tr>
<tr><td class="paramname">N_cap</td><td>Ring capacity (in number of elements) </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a758a2e9010d402e3eb6114b70cfa095e" name="a758a2e9010d402e3eb6114b70cfa095e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a758a2e9010d402e3eb6114b70cfa095e">&#9670;&#160;</a></span>back()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , size_t N_cap&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::tuple&lt; T *, size_t &gt; <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>&lt; T, N_cap &gt;::back </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></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>Allocates the data after the ring tail. Use <a class="el" href="#ad92cabdc54343abd20c2c1603effb1af" title="Notifies the receiver the data was populated.">push()</a> after the allocated data is populated. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to data available for writing and maximum data size to write. Or, <code>{nullptr, 0}</code> if <a class="el" href="#a8b06a04256d3ba57818f04adc54af72c" title="Cancells waiting sender and receiver.">quit()</a> has been called. </dd></dl>
</div>
</div>
<a id="ad49cdfeb722bc80d51ba1db7e53e9366" name="ad49cdfeb722bc80d51ba1db7e53e9366"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad49cdfeb722bc80d51ba1db7e53e9366">&#9670;&#160;</a></span>front()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , size_t N_cap&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::tuple&lt; T *, size_t &gt; <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>&lt; T, N_cap &gt;::front </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></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>Peeks the data at the ring head. Use <a class="el" href="#a404fe1f77852c304206369546695b566" title="Notifies the sender the data was consumed.">pop()</a> after the data was consumed. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to data available for reading and maximum data size to read. Or, <code>{nullptr, 0}</code> if <a class="el" href="#a8b06a04256d3ba57818f04adc54af72c" title="Cancells waiting sender and receiver.">quit()</a> has been called. </dd></dl>
</div>
</div>
<a id="a404fe1f77852c304206369546695b566" name="a404fe1f77852c304206369546695b566"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a404fe1f77852c304206369546695b566">&#9670;&#160;</a></span>pop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , size_t N_cap&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>&lt; T, N_cap &gt;::pop </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span></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>Notifies the sender the data was consumed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Amount of data that was really consumed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad92cabdc54343abd20c2c1603effb1af" name="ad92cabdc54343abd20c2c1603effb1af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad92cabdc54343abd20c2c1603effb1af">&#9670;&#160;</a></span>push()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , size_t N_cap&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>&lt; T, N_cap &gt;::push </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span></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>Notifies the receiver the data was populated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Amount of data that was really populated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="ring_8hpp_source.html">ring.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 21 2024 12:18:10 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>