stdex/ring_8hpp_source.html

251 lines
25 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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: include/stdex/ring.hpp Source File</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.11.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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_fca3c47b2ea228727bd6729832f89576.html">stdex</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">ring.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2023-2024 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">*/</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;assert.hpp&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;compat.hpp&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;condition_variable&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;tuple&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#if defined(__GNUC__)</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#pragma GCC diagnostic push</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#pragma GCC diagnostic ignored &quot;-Wunknown-pragmas&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">namespace </span>stdex</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keywordtype">size_t</span> N_cap&gt;</div>
<div class="foldopen" id="foldopen00028" data-start="{" data-end="};">
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html"> 28</a></span> <span class="keyword">class </span><a class="code hl_class" href="classstdex_1_1ring.html">ring</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#pragma warning(suppress:26495) </span><span class="comment">// Don&#39;t bother to initialize m_data</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="classstdex_1_1ring.html">ring</a>() :</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> m_head(0),</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> m_size(0),</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> m_quit(<span class="keyword">false</span>)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#a758a2e9010d402e3eb6114b70cfa095e"> 43</a></span> std::tuple&lt;T*, size_t&gt; <a class="code hl_function" href="classstdex_1_1ring.html#a758a2e9010d402e3eb6114b70cfa095e">back</a>()</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> std::unique_lock&lt;std::mutex&gt; lk(m_mutex);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">if</span> (!space()) {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> m_head_moved.wait(lk, [&amp;]{<span class="keywordflow">return</span> m_quit || space();});</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (m_quit) _Unlikely_</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> { <span class="keyword">nullptr</span>, 0 };</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">size_t</span> tail = wrap(m_head + m_size);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> { &amp;m_data[tail], m_head &lt;= tail ? N_cap - tail : m_head - tail };</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="foldopen" id="foldopen00060" data-start="{" data-end="}">
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#ad92cabdc54343abd20c2c1603effb1af"> 60</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1ring.html#ad92cabdc54343abd20c2c1603effb1af">push</a>(_In_ <span class="keywordtype">size_t</span> size)</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> {</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">const</span> std::lock_guard&lt;std::mutex&gt; lg(m_mutex);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">size_t</span> tail = wrap(m_head + m_size);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> stdex_assert(size &lt;= (m_head &lt;= tail ? N_cap - tail : m_head - tail));</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> m_size += size;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> m_tail_moved.notify_one();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#ad49cdfeb722bc80d51ba1db7e53e9366"> 78</a></span> std::tuple&lt;T*, size_t&gt; <a class="code hl_function" href="classstdex_1_1ring.html#ad49cdfeb722bc80d51ba1db7e53e9366">front</a>()</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> std::unique_lock&lt;std::mutex&gt; lk(m_mutex);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">if</span> (empty()) {</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> m_tail_moved.wait(lk, [&amp;]{<span class="keywordflow">return</span> m_quit || !empty();});</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">if</span> (m_quit &amp;&amp; empty()) _Unlikely_</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">return</span> { <span class="keyword">nullptr</span>, 0 };</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">size_t</span> tail = wrap(m_head + m_size);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> { &amp;m_data[m_head], m_head &lt; tail ? m_size : N_cap - m_head };</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="foldopen" id="foldopen00095" data-start="{" data-end="}">
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#a404fe1f77852c304206369546695b566"> 95</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1ring.html#a404fe1f77852c304206369546695b566">pop</a>(_In_ <span class="keywordtype">size_t</span> size)</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> {</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> std::lock_guard&lt;std::mutex&gt; lg(m_mutex);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">size_t</span> tail = wrap(m_head + m_size);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> stdex_assert(size &lt;= (m_head &lt; tail ? m_size : N_cap - m_head));</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> m_head = wrap(m_head + size);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> m_size -= size;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> }</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> m_head_moved.notify_one();</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> }</div>
</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="foldopen" id="foldopen00112" data-start="{" data-end="}">
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#a8b06a04256d3ba57818f04adc54af72c"> 112</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1ring.html#a8b06a04256d3ba57818f04adc54af72c">quit</a>()</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> {</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> {</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">const</span> std::lock_guard&lt;std::mutex&gt; lg(m_mutex);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> m_quit = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> }</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> m_head_moved.notify_one();</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> m_tail_moved.notify_one();</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> }</div>
</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="foldopen" id="foldopen00125" data-start="{" data-end="}">
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classstdex_1_1ring.html#af2c895c0664cdcfc156e5a9fa42b30c3"> 125</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1ring.html#af2c895c0664cdcfc156e5a9fa42b30c3">sync</a>()</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> {</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> std::unique_lock&lt;std::mutex&gt; lk(m_mutex);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> m_head_moved.wait(lk, [&amp;]{<span class="keywordflow">return</span> m_quit || empty();});</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> }</div>
</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">size_t</span> wrap(_In_ <span class="keywordtype">size_t</span> idx)<span class="keyword"> const</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="comment">// TODO: When N_cap is power of 2, use &amp; ~(N_cap - 1) instead.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keywordflow">return</span> idx % N_cap;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> }</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">size_t</span> space()<span class="keyword"> const</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordflow">return</span> N_cap - m_size;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> }</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keywordtype">bool</span> empty()<span class="keyword"> const</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keywordflow">return</span> !m_size;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> }</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> std::mutex m_mutex;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> std::condition_variable m_head_moved, m_tail_moved;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">size_t</span> m_head, m_size;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="keywordtype">bool</span> m_quit;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> T m_data[N_cap];</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> };</div>
</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>}</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="preprocessor">#if defined(__GNUC__)</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><span class="preprocessor">#pragma GCC diagnostic pop</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstdex_1_1ring_html"><div class="ttname"><a href="classstdex_1_1ring.html">stdex::ring</a></div><div class="ttdoc">Ring buffer.</div><div class="ttdef"><b>Definition</b> ring.hpp:29</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_a404fe1f77852c304206369546695b566"><div class="ttname"><a href="classstdex_1_1ring.html#a404fe1f77852c304206369546695b566">stdex::ring::pop</a></div><div class="ttdeci">void pop(size_t size)</div><div class="ttdoc">Notifies the sender the data was consumed.</div><div class="ttdef"><b>Definition</b> ring.hpp:95</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_a758a2e9010d402e3eb6114b70cfa095e"><div class="ttname"><a href="classstdex_1_1ring.html#a758a2e9010d402e3eb6114b70cfa095e">stdex::ring::back</a></div><div class="ttdeci">std::tuple&lt; T *, size_t &gt; back()</div><div class="ttdoc">Allocates the data after the ring tail. Use push() after the allocated data is populated.</div><div class="ttdef"><b>Definition</b> ring.hpp:43</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_a8b06a04256d3ba57818f04adc54af72c"><div class="ttname"><a href="classstdex_1_1ring.html#a8b06a04256d3ba57818f04adc54af72c">stdex::ring::quit</a></div><div class="ttdeci">void quit()</div><div class="ttdoc">Cancells waiting sender and receiver.</div><div class="ttdef"><b>Definition</b> ring.hpp:112</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_ad49cdfeb722bc80d51ba1db7e53e9366"><div class="ttname"><a href="classstdex_1_1ring.html#ad49cdfeb722bc80d51ba1db7e53e9366">stdex::ring::front</a></div><div class="ttdeci">std::tuple&lt; T *, size_t &gt; front()</div><div class="ttdoc">Peeks the data at the ring head. Use pop() after the data was consumed.</div><div class="ttdef"><b>Definition</b> ring.hpp:78</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_ad92cabdc54343abd20c2c1603effb1af"><div class="ttname"><a href="classstdex_1_1ring.html#ad92cabdc54343abd20c2c1603effb1af">stdex::ring::push</a></div><div class="ttdeci">void push(size_t size)</div><div class="ttdoc">Notifies the receiver the data was populated.</div><div class="ttdef"><b>Definition</b> ring.hpp:60</div></div>
<div class="ttc" id="aclassstdex_1_1ring_html_af2c895c0664cdcfc156e5a9fa42b30c3"><div class="ttname"><a href="classstdex_1_1ring.html#af2c895c0664cdcfc156e5a9fa42b30c3">stdex::ring::sync</a></div><div class="ttdeci">void sync()</div><div class="ttdoc">Waits until the ring is flush.</div><div class="ttdef"><b>Definition</b> ring.hpp:125</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 28 2024 09:54:34 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.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>