detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 13:40:39 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/classaare_1_1CircularFifo.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

699 lines
31 KiB
HTML
Raw Permalink Blame History

<!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: aare::CircularFifo&lt; ItemType &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>
<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="namespaceaare.html">aare</a></li><li class="navelem"><a class="el" href="classaare_1_1CircularFifo.html">CircularFifo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle"><div class="title">aare::CircularFifo&lt; ItemType &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="CircularFifo_8hpp_source.html">CircularFifo.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a37b26e1fd9d6904cef2d1cafda316dc0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a37b26e1fd9d6904cef2d1cafda316dc0">value_type</a> = ItemType</td></tr>
<tr class="separator:a37b26e1fd9d6904cef2d1cafda316dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a8579c56895285557b6029db73f5b2af3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a8579c56895285557b6029db73f5b2af3">CircularFifo</a> ()</td></tr>
<tr class="separator:a8579c56895285557b6029db73f5b2af3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeda9cfed3526a9c4241fcc9ed4ba163"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#abeda9cfed3526a9c4241fcc9ed4ba163">CircularFifo</a> (uint32_t size)</td></tr>
<tr class="separator:abeda9cfed3526a9c4241fcc9ed4ba163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4e41499b0c82bb4264739a55fef2cdc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#af4e41499b0c82bb4264739a55fef2cdc">next</a> ()</td></tr>
<tr class="separator:af4e41499b0c82bb4264739a55fef2cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a2d8bb747eb3235b2bddd88216b1733"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a2a2d8bb747eb3235b2bddd88216b1733">~CircularFifo</a> ()</td></tr>
<tr class="separator:a2a2d8bb747eb3235b2bddd88216b1733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbf8f710904794b3994363161fbb2cab"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#afbf8f710904794b3994363161fbb2cab">numFilledSlots</a> () const noexcept</td></tr>
<tr class="separator:afbf8f710904794b3994363161fbb2cab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9190570892efabe5d2cb6fbdcd31c813"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a9190570892efabe5d2cb6fbdcd31c813">numFreeSlots</a> () const noexcept</td></tr>
<tr class="separator:a9190570892efabe5d2cb6fbdcd31c813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7ef1972a9b372c36c048f358f3bc977"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#ae7ef1972a9b372c36c048f358f3bc977">isFull</a> () const noexcept</td></tr>
<tr class="separator:ae7ef1972a9b372c36c048f358f3bc977"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7065cd5808ef6226fd36d0a522678b41"><td class="memItemLeft" align="right" valign="top">ItemType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a7065cd5808ef6226fd36d0a522678b41">pop_free</a> ()</td></tr>
<tr class="separator:a7065cd5808ef6226fd36d0a522678b41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ee728381a85f2105739db57b3a3c74d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a1ee728381a85f2105739db57b3a3c74d">try_pop_free</a> (ItemType &amp;v)</td></tr>
<tr class="separator:a1ee728381a85f2105739db57b3a3c74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af10fb2772258ac5f3001a48f42ddc466"><td class="memItemLeft" align="right" valign="top">ItemType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#af10fb2772258ac5f3001a48f42ddc466">pop_value</a> (std::chrono::nanoseconds wait, std::atomic&lt; bool &gt; &amp;stopped)</td></tr>
<tr class="separator:af10fb2772258ac5f3001a48f42ddc466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3568e05982e05668593ebf5d033cb0f6"><td class="memItemLeft" align="right" valign="top">ItemType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a3568e05982e05668593ebf5d033cb0f6">pop_value</a> ()</td></tr>
<tr class="separator:a3568e05982e05668593ebf5d033cb0f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6570667d6859e219f3519812c5a24a"><td class="memItemLeft" align="right" valign="top">ItemType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#ace6570667d6859e219f3519812c5a24a">frontPtr</a> ()</td></tr>
<tr class="separator:ace6570667d6859e219f3519812c5a24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0637495a0c030ad77e78b14cbe619ad"><td class="memTemplParams" colspan="2">template&lt;class... Args&gt; </td></tr>
<tr class="memitem:ae0637495a0c030ad77e78b14cbe619ad"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#ae0637495a0c030ad77e78b14cbe619ad">push_value</a> (Args &amp;&amp;...recordArgs)</td></tr>
<tr class="separator:ae0637495a0c030ad77e78b14cbe619ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa16fd4ce93fb94b7214353cabfefc1e1"><td class="memTemplParams" colspan="2">template&lt;class... Args&gt; </td></tr>
<tr class="memitem:aa16fd4ce93fb94b7214353cabfefc1e1"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#aa16fd4ce93fb94b7214353cabfefc1e1">try_push_value</a> (Args &amp;&amp;...recordArgs)</td></tr>
<tr class="separator:aa16fd4ce93fb94b7214353cabfefc1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d58312a721120580eb030c6524c35ec"><td class="memTemplParams" colspan="2">template&lt;class... Args&gt; </td></tr>
<tr class="memitem:a0d58312a721120580eb030c6524c35ec"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a0d58312a721120580eb030c6524c35ec">push_free</a> (Args &amp;&amp;...recordArgs)</td></tr>
<tr class="separator:a0d58312a721120580eb030c6524c35ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae643565632229878f01a88f650ea5e3a"><td class="memTemplParams" colspan="2">template&lt;class... Args&gt; </td></tr>
<tr class="memitem:ae643565632229878f01a88f650ea5e3a"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#ae643565632229878f01a88f650ea5e3a">try_push_free</a> (Args &amp;&amp;...recordArgs)</td></tr>
<tr class="separator:ae643565632229878f01a88f650ea5e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af2c357b41296f0516b402feae91dc82d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#af2c357b41296f0516b402feae91dc82d">fifo_size</a></td></tr>
<tr class="separator:af2c357b41296f0516b402feae91dc82d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08760281625cee96d79104c4321dbf4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue</a>&lt; ItemType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#ad08760281625cee96d79104c4321dbf4">free_slots</a></td></tr>
<tr class="separator:ad08760281625cee96d79104c4321dbf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28f5f6090b7812d18543b213c4d3177f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue</a>&lt; ItemType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1CircularFifo.html#a28f5f6090b7812d18543b213c4d3177f">filled_slots</a></td></tr>
<tr class="separator:a28f5f6090b7812d18543b213c4d3177f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a37b26e1fd9d6904cef2d1cafda316dc0" name="a37b26e1fd9d6904cef2d1cafda316dc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b26e1fd9d6904cef2d1cafda316dc0">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::value_type = ItemType</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8579c56895285557b6029db73f5b2af3" name="a8579c56895285557b6029db73f5b2af3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8579c56895285557b6029db73f5b2af3">&#9670;&#160;</a></span>CircularFifo() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::CircularFifo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abeda9cfed3526a9c4241fcc9ed4ba163" name="abeda9cfed3526a9c4241fcc9ed4ba163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeda9cfed3526a9c4241fcc9ed4ba163">&#9670;&#160;</a></span>CircularFifo() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::CircularFifo </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2a2d8bb747eb3235b2bddd88216b1733" name="a2a2d8bb747eb3235b2bddd88216b1733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a2d8bb747eb3235b2bddd88216b1733">&#9670;&#160;</a></span>~CircularFifo()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::~<a class="el" href="classaare_1_1CircularFifo.html">CircularFifo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ace6570667d6859e219f3519812c5a24a" name="ace6570667d6859e219f3519812c5a24a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace6570667d6859e219f3519812c5a24a">&#9670;&#160;</a></span>frontPtr()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ItemType * <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::frontPtr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae7ef1972a9b372c36c048f358f3bc977" name="ae7ef1972a9b372c36c048f358f3bc977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7ef1972a9b372c36c048f358f3bc977">&#9670;&#160;</a></span>isFull()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::isFull </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af4e41499b0c82bb4264739a55fef2cdc" name="af4e41499b0c82bb4264739a55fef2cdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4e41499b0c82bb4264739a55fef2cdc">&#9670;&#160;</a></span>next()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afbf8f710904794b3994363161fbb2cab" name="afbf8f710904794b3994363161fbb2cab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbf8f710904794b3994363161fbb2cab">&#9670;&#160;</a></span>numFilledSlots()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::numFilledSlots </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9190570892efabe5d2cb6fbdcd31c813" name="a9190570892efabe5d2cb6fbdcd31c813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9190570892efabe5d2cb6fbdcd31c813">&#9670;&#160;</a></span>numFreeSlots()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::numFreeSlots </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7065cd5808ef6226fd36d0a522678b41" name="a7065cd5808ef6226fd36d0a522678b41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7065cd5808ef6226fd36d0a522678b41">&#9670;&#160;</a></span>pop_free()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ItemType <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::pop_free </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3568e05982e05668593ebf5d033cb0f6" name="a3568e05982e05668593ebf5d033cb0f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3568e05982e05668593ebf5d033cb0f6">&#9670;&#160;</a></span>pop_value() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ItemType <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::pop_value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af10fb2772258ac5f3001a48f42ddc466" name="af10fb2772258ac5f3001a48f42ddc466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af10fb2772258ac5f3001a48f42ddc466">&#9670;&#160;</a></span>pop_value() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ItemType <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::pop_value </td>
<td>(</td>
<td class="paramtype">std::chrono::nanoseconds&#160;</td>
<td class="paramname"><em>wait</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::atomic&lt; bool &gt; &amp;&#160;</td>
<td class="paramname"><em>stopped</em>&#160;</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">
</div>
</div>
<a id="a0d58312a721120580eb030c6524c35ec" name="a0d58312a721120580eb030c6524c35ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d58312a721120580eb030c6524c35ec">&#9670;&#160;</a></span>push_free()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<div class="memtemplate">
template&lt;class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::push_free </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>recordArgs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae0637495a0c030ad77e78b14cbe619ad" name="ae0637495a0c030ad77e78b14cbe619ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0637495a0c030ad77e78b14cbe619ad">&#9670;&#160;</a></span>push_value()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<div class="memtemplate">
template&lt;class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::push_value </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>recordArgs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1ee728381a85f2105739db57b3a3c74d" name="a1ee728381a85f2105739db57b3a3c74d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ee728381a85f2105739db57b3a3c74d">&#9670;&#160;</a></span>try_pop_free()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::try_pop_free </td>
<td>(</td>
<td class="paramtype">ItemType &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae643565632229878f01a88f650ea5e3a" name="ae643565632229878f01a88f650ea5e3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae643565632229878f01a88f650ea5e3a">&#9670;&#160;</a></span>try_push_free()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<div class="memtemplate">
template&lt;class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::try_push_free </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>recordArgs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa16fd4ce93fb94b7214353cabfefc1e1" name="aa16fd4ce93fb94b7214353cabfefc1e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa16fd4ce93fb94b7214353cabfefc1e1">&#9670;&#160;</a></span>try_push_value()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<div class="memtemplate">
template&lt;class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::try_push_value </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>recordArgs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="af2c357b41296f0516b402feae91dc82d" name="af2c357b41296f0516b402feae91dc82d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2c357b41296f0516b402feae91dc82d">&#9670;&#160;</a></span>fifo_size</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::fifo_size</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a28f5f6090b7812d18543b213c4d3177f" name="a28f5f6090b7812d18543b213c4d3177f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28f5f6090b7812d18543b213c4d3177f">&#9670;&#160;</a></span>filled_slots</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue</a>&lt;ItemType&gt; <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::filled_slots</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad08760281625cee96d79104c4321dbf4" name="ad08760281625cee96d79104c4321dbf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad08760281625cee96d79104c4321dbf4">&#9670;&#160;</a></span>free_slots</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ItemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structfolly_1_1ProducerConsumerQueue.html">folly::ProducerConsumerQueue</a>&lt;ItemType&gt; <a class="el" href="classaare_1_1CircularFifo.html">aare::CircularFifo</a>&lt; ItemType &gt;::free_slots</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/include/aare/core/<a class="el" href="CircularFifo_8hpp_source.html">CircularFifo.hpp</a></li>
</ul>
</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>
View Git Blame Copy Permalink