aare/docs/html/CircularFifo_8hpp_source.html
2024-04-11 17:20:34 +02:00

213 lines
34 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.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AARE: core/include/aare/core/CircularFifo.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>
<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">AARE
</div>
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
<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_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_24d671cfcbc5d5238a6bd565a49d198f.html">include</a></li><li class="navelem"><a class="el" href="dir_2c69decb5c62900c73cbf4abc58a8693.html">aare</a></li><li class="navelem"><a class="el" href="dir_e51344b9c4a46f8ed8ec1e9a48398749.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">CircularFifo.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="CircularFifo_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;fmt/color.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;fmt/format.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;thread&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="ProducerConsumerQueue_8hpp.html">aare/core/ProducerConsumerQueue.hpp</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespaceaare.html"> 11</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaare.html">aare</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html"> 13</a></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> ItemType&gt; <span class="keyword">class </span><a class="code hl_class" href="classaare_1_1CircularFifo.html">CircularFifo</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d"> 14</a></span> uint32_t <a class="code hl_variable" href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d">fifo_size</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4"> 15</a></span> <a class="code hl_struct" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue&lt;ItemType&gt;</a> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f"> 16</a></span> <a class="code hl_struct" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue&lt;ItemType&gt;</a> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a8579c56895285557b6029db73f5b2af3"> 19</a></span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#a8579c56895285557b6029db73f5b2af3">CircularFifo</a>() : <a class="code hl_class" href="classaare_1_1CircularFifo.html">CircularFifo</a>(100){};</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#abeda9cfed3526a9c4241fcc9ed4ba163"> 20</a></span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#abeda9cfed3526a9c4241fcc9ed4ba163">CircularFifo</a>(uint32_t size) : <a class="code hl_variable" href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d">fifo_size</a>(size), <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>(size + 1), <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>(size + 1) {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// TODO! how do we deal with alignment for writing? alignas???</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// Do we give the user a chance to provide memory locations?</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Templated allocator?</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code hl_variable" href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d">fifo_size</a>; ++i) {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(ItemType{});</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> }</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> }</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"><a class="line" href="classaare_1_1CircularFifo.html#af4e41499b0c82bb4264739a55fef2cdc"> 30</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#af4e41499b0c82bb4264739a55fef2cdc">next</a>() {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// TODO! avoid default constructing ItemType</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> ItemType it;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">read</a>(it))</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(std::move(it)))</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a2a2d8bb747eb3235b2bddd88216b1733"> 40</a></span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#a2a2d8bb747eb3235b2bddd88216b1733">~CircularFifo</a>() {}</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a37b26e1fd9d6904cef2d1cafda316dc0"> 42</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classaare_1_1CircularFifo.html#a37b26e1fd9d6904cef2d1cafda316dc0">value_type</a> = ItemType;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#afbf8f710904794b3994363161fbb2cab"> 44</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#afbf8f710904794b3994363161fbb2cab">numFilledSlots</a>() const noexcept { <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#adb384b6a25b755b627d04ff6f2ca9c95">sizeGuess</a>(); }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a9190570892efabe5d2cb6fbdcd31c813"> 45</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#a9190570892efabe5d2cb6fbdcd31c813">numFreeSlots</a>() const noexcept { <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#adb384b6a25b755b627d04ff6f2ca9c95">sizeGuess</a>(); }</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#ae7ef1972a9b372c36c048f358f3bc977"> 46</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#ae7ef1972a9b372c36c048f358f3bc977">isFull</a>() const noexcept { <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#ad883c041917c2b7f10b0ecdaeaeb0577">isFull</a>(); }</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a7065cd5808ef6226fd36d0a522678b41"> 48</a></span> ItemType <a class="code hl_function" href="classaare_1_1CircularFifo.html#a7065cd5808ef6226fd36d0a522678b41">pop_free</a>() {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> ItemType v;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">read</a>(v))</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> ;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> std::move(v);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// return v;</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a1ee728381a85f2105739db57b3a3c74d"> 56</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#a1ee728381a85f2105739db57b3a3c74d">try_pop_free</a>(ItemType &amp;v) { <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">read</a>(v); }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#af10fb2772258ac5f3001a48f42ddc466"> 58</a></span> ItemType <a class="code hl_function" href="classaare_1_1CircularFifo.html#af10fb2772258ac5f3001a48f42ddc466">pop_value</a>(std::chrono::nanoseconds wait, std::atomic&lt;bool&gt; &amp;stopped) {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> ItemType v;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">read</a>(v) &amp;&amp; !stopped) {</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> std::this_thread::sleep_for(wait);</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="keywordflow">return</span> std::move(v);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a3568e05982e05668593ebf5d033cb0f6"> 66</a></span> ItemType <a class="code hl_function" href="classaare_1_1CircularFifo.html#a3568e05982e05668593ebf5d033cb0f6">pop_value</a>() {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> ItemType v;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">read</a>(v))</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> <span class="keywordflow">return</span> std::move(v);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#ace6570667d6859e219f3519812c5a24a"> 73</a></span> ItemType *<a class="code hl_function" href="classaare_1_1CircularFifo.html#ace6570667d6859e219f3519812c5a24a">frontPtr</a>() { <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#a24474b670bc44f75f7c978087e401bd0">frontPtr</a>(); }</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// TODO! Add function to move item from filled to free to be used</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// with the frontPtr function</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#ae0637495a0c030ad77e78b14cbe619ad"> 78</a></span> <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt; <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#ae0637495a0c030ad77e78b14cbe619ad">push_value</a>(Args &amp;&amp;...recordArgs) {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(std::forward&lt;Args&gt;(recordArgs)...))</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> ;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#aa16fd4ce93fb94b7214353cabfefc1e1"> 83</a></span> <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt; <span class="keywordtype">bool</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#aa16fd4ce93fb94b7214353cabfefc1e1">try_push_value</a>(Args &amp;&amp;...recordArgs) {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(std::forward&lt;Args&gt;(recordArgs)...);</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> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#a0d58312a721120580eb030c6524c35ec"> 87</a></span> <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt; <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#a0d58312a721120580eb030c6524c35ec">push_free</a>(Args &amp;&amp;...recordArgs) {</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(std::forward&lt;Args&gt;(recordArgs)...))</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> ;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> }</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classaare_1_1CircularFifo.html#ae643565632229878f01a88f650ea5e3a"> 92</a></span> <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt; <span class="keywordtype">bool</span> <a class="code hl_function" href="classaare_1_1CircularFifo.html#ae643565632229878f01a88f650ea5e3a">try_push_free</a>(Args &amp;&amp;...recordArgs) {</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a>.<a class="code hl_function" href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">write</a>(std::forward&lt;Args&gt;(recordArgs)...);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> }</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>};</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>} <span class="comment">// namespace aare</span></div>
<div class="ttc" id="aProducerConsumerQueue_8hpp_html"><div class="ttname"><a href="ProducerConsumerQueue_8hpp.html">ProducerConsumerQueue.hpp</a></div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html"><div class="ttname"><a href="classaare_1_1CircularFifo.html">aare::CircularFifo</a></div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:13</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a0d58312a721120580eb030c6524c35ec"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a0d58312a721120580eb030c6524c35ec">aare::CircularFifo::push_free</a></div><div class="ttdeci">void push_free(Args &amp;&amp;...recordArgs)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:87</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a1ee728381a85f2105739db57b3a3c74d"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a1ee728381a85f2105739db57b3a3c74d">aare::CircularFifo::try_pop_free</a></div><div class="ttdeci">bool try_pop_free(ItemType &amp;v)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:56</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a28f5f6090b7812d18543b213c4d3177f"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">aare::CircularFifo::filled_slots</a></div><div class="ttdeci">folly::ProducerConsumerQueue&lt; ItemType &gt; filled_slots</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:16</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a2a2d8bb747eb3235b2bddd88216b1733"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a2a2d8bb747eb3235b2bddd88216b1733">aare::CircularFifo::~CircularFifo</a></div><div class="ttdeci">~CircularFifo()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:40</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a3568e05982e05668593ebf5d033cb0f6"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a3568e05982e05668593ebf5d033cb0f6">aare::CircularFifo::pop_value</a></div><div class="ttdeci">ItemType pop_value()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:66</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a37b26e1fd9d6904cef2d1cafda316dc0"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a37b26e1fd9d6904cef2d1cafda316dc0">aare::CircularFifo::value_type</a></div><div class="ttdeci">ItemType value_type</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:42</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a7065cd5808ef6226fd36d0a522678b41"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a7065cd5808ef6226fd36d0a522678b41">aare::CircularFifo::pop_free</a></div><div class="ttdeci">ItemType pop_free()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:48</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a8579c56895285557b6029db73f5b2af3"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a8579c56895285557b6029db73f5b2af3">aare::CircularFifo::CircularFifo</a></div><div class="ttdeci">CircularFifo()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:19</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_a9190570892efabe5d2cb6fbdcd31c813"><div class="ttname"><a href="classaare_1_1CircularFifo.html#a9190570892efabe5d2cb6fbdcd31c813">aare::CircularFifo::numFreeSlots</a></div><div class="ttdeci">auto numFreeSlots() const noexcept</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:45</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_aa16fd4ce93fb94b7214353cabfefc1e1"><div class="ttname"><a href="classaare_1_1CircularFifo.html#aa16fd4ce93fb94b7214353cabfefc1e1">aare::CircularFifo::try_push_value</a></div><div class="ttdeci">bool try_push_value(Args &amp;&amp;...recordArgs)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:83</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_abeda9cfed3526a9c4241fcc9ed4ba163"><div class="ttname"><a href="classaare_1_1CircularFifo.html#abeda9cfed3526a9c4241fcc9ed4ba163">aare::CircularFifo::CircularFifo</a></div><div class="ttdeci">CircularFifo(uint32_t size)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:20</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_ace6570667d6859e219f3519812c5a24a"><div class="ttname"><a href="classaare_1_1CircularFifo.html#ace6570667d6859e219f3519812c5a24a">aare::CircularFifo::frontPtr</a></div><div class="ttdeci">ItemType * frontPtr()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:73</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_ad08760281625cee96d79104c4321dbf4"><div class="ttname"><a href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">aare::CircularFifo::free_slots</a></div><div class="ttdeci">folly::ProducerConsumerQueue&lt; ItemType &gt; free_slots</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:15</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_ae0637495a0c030ad77e78b14cbe619ad"><div class="ttname"><a href="classaare_1_1CircularFifo.html#ae0637495a0c030ad77e78b14cbe619ad">aare::CircularFifo::push_value</a></div><div class="ttdeci">void push_value(Args &amp;&amp;...recordArgs)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:78</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_ae643565632229878f01a88f650ea5e3a"><div class="ttname"><a href="classaare_1_1CircularFifo.html#ae643565632229878f01a88f650ea5e3a">aare::CircularFifo::try_push_free</a></div><div class="ttdeci">bool try_push_free(Args &amp;&amp;...recordArgs)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:92</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_ae7ef1972a9b372c36c048f358f3bc977"><div class="ttname"><a href="classaare_1_1CircularFifo.html#ae7ef1972a9b372c36c048f358f3bc977">aare::CircularFifo::isFull</a></div><div class="ttdeci">auto isFull() const noexcept</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:46</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_af10fb2772258ac5f3001a48f42ddc466"><div class="ttname"><a href="classaare_1_1CircularFifo.html#af10fb2772258ac5f3001a48f42ddc466">aare::CircularFifo::pop_value</a></div><div class="ttdeci">ItemType pop_value(std::chrono::nanoseconds wait, std::atomic&lt; bool &gt; &amp;stopped)</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:58</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_af2c357b41296f0516b402feae91dc82d"><div class="ttname"><a href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d">aare::CircularFifo::fifo_size</a></div><div class="ttdeci">uint32_t fifo_size</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:14</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_af4e41499b0c82bb4264739a55fef2cdc"><div class="ttname"><a href="classaare_1_1CircularFifo.html#af4e41499b0c82bb4264739a55fef2cdc">aare::CircularFifo::next</a></div><div class="ttdeci">bool next()</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:30</div></div>
<div class="ttc" id="aclassaare_1_1CircularFifo_html_afbf8f710904794b3994363161fbb2cab"><div class="ttname"><a href="classaare_1_1CircularFifo.html#afbf8f710904794b3994363161fbb2cab">aare::CircularFifo::numFilledSlots</a></div><div class="ttdeci">auto numFilledSlots() const noexcept</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:44</div></div>
<div class="ttc" id="anamespaceaare_html"><div class="ttname"><a href="namespaceaare.html">aare</a></div><div class="ttdoc">Frame class to represent a single frame of data model class should be able to work with streams comin...</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:11</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue</a></div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:41</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html_a24474b670bc44f75f7c978087e401bd0"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html#a24474b670bc44f75f7c978087e401bd0">folly::ProducerConsumerQueue::frontPtr</a></div><div class="ttdeci">T * frontPtr()</div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:114</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html_a3288ef770695d676376c80ea41630b74"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html#a3288ef770695d676376c80ea41630b74">folly::ProducerConsumerQueue::read</a></div><div class="ttdeci">bool read(T &amp;record)</div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:95</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html_ad883c041917c2b7f10b0ecdaeaeb0577"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html#ad883c041917c2b7f10b0ecdaeaeb0577">folly::ProducerConsumerQueue::isFull</a></div><div class="ttdeci">bool isFull() const</div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:140</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html_adb384b6a25b755b627d04ff6f2ca9c95"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html#adb384b6a25b755b627d04ff6f2ca9c95">folly::ProducerConsumerQueue::sizeGuess</a></div><div class="ttdeci">size_t sizeGuess() const</div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:157</div></div>
<div class="ttc" id="astructfolly_1_1ProducerConsumerQueue_html_af849682c2351c5f2b3344e32c512a961"><div class="ttname"><a href="structfolly_1_1ProducerConsumerQueue.html#af849682c2351c5f2b3344e32c512a961">folly::ProducerConsumerQueue::write</a></div><div class="ttdeci">bool write(Args &amp;&amp;...recordArgs)</div><div class="ttdef"><b>Definition</b> ProducerConsumerQueue.hpp:78</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>