Files
rippled/classbeast_1_1LockFreeStack.html
2025-11-04 00:36:48 -08:00

694 lines
42 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: beast::LockFreeStack&lt; Element, Tag &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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classbeast_1_1LockFreeStack-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">beast::LockFreeStack&lt; Element, Tag &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Multiple Producer, Multiple Consumer (MPMC) intrusive stack.
<a href="classbeast_1_1LockFreeStack.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for beast::LockFreeStack&lt; Element, Tag &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1LockFreeStack__coll__graph.png" border="0" usemap="#abeast_1_1LockFreeStack_3_01Element_00_01Tag_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="abeast_1_1LockFreeStack_3_01Element_00_01Tag_01_4_coll__map" id="abeast_1_1LockFreeStack_3_01Element_00_01Tag_01_4_coll__map">
<area shape="rect" title="Multiple Producer, Multiple Consumer (MPMC) intrusive stack." alt="" coords="583,8,743,48"/>
<area shape="rect" href="classbeast_1_1LockFreeStack_1_1Node.html" title=" " alt="" coords="5,9,184,49"/>
<area shape="poly" title=" " alt="" coords="198,22,208,21,383,16,559,19,582,20,582,25,559,24,383,22,208,27,198,27"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="285,43,477,83"/>
<area shape="poly" title=" " alt="" coords="198,39,285,49,285,54,197,44"/>
<area shape="poly" title=" " alt="" coords="490,47,582,35,583,40,491,52"/>
<area shape="poly" title=" " alt="" coords="271,80,208,76,170,66,135,52,137,47,172,61,208,71,272,75"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a1e2bf8329b989a61a93798398dd915df" id="r_a1e2bf8329b989a61a93798398dd915df"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a1e2bf8329b989a61a93798398dd915df">value_type</a> = Element</td></tr>
<tr class="separator:a1e2bf8329b989a61a93798398dd915df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54a6e87c5584596b73c7e4794073d124" id="r_a54a6e87c5584596b73c7e4794073d124"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a54a6e87c5584596b73c7e4794073d124">pointer</a> = Element *</td></tr>
<tr class="separator:a54a6e87c5584596b73c7e4794073d124"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69d547559317ce53da3d193e27cd68be" id="r_a69d547559317ce53da3d193e27cd68be"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a69d547559317ce53da3d193e27cd68be">reference</a> = Element &amp;</td></tr>
<tr class="separator:a69d547559317ce53da3d193e27cd68be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1c9f40e6c35c2384a880b0e14a0aa0d" id="r_ab1c9f40e6c35c2384a880b0e14a0aa0d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ab1c9f40e6c35c2384a880b0e14a0aa0d">const_pointer</a> = Element const *</td></tr>
<tr class="separator:ab1c9f40e6c35c2384a880b0e14a0aa0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac208bf5e265cf6e499c2431f529c7f02" id="r_ac208bf5e265cf6e499c2431f529c7f02"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ac208bf5e265cf6e499c2431f529c7f02">const_reference</a> = Element const &amp;</td></tr>
<tr class="separator:ac208bf5e265cf6e499c2431f529c7f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac61f4f5b0dc1bc269337f70e0460f061" id="r_ac61f4f5b0dc1bc269337f70e0460f061"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ac61f4f5b0dc1bc269337f70e0460f061">size_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></td></tr>
<tr class="separator:ac61f4f5b0dc1bc269337f70e0460f061"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc69aefb629e0761668a99569c397d8e" id="r_acc69aefb629e0761668a99569c397d8e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#acc69aefb629e0761668a99569c397d8e">difference_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/ptrdiff_t.html">std::ptrdiff_t</a></td></tr>
<tr class="separator:acc69aefb629e0761668a99569c397d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44788dc656182b46ee0e9bf534eec4c2" id="r_a44788dc656182b46ee0e9bf534eec4c2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a44788dc656182b46ee0e9bf534eec4c2">iterator</a> = <a class="el" href="classbeast_1_1LockFreeStackIterator.html">LockFreeStackIterator</a>&lt; <a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt; Element, Tag &gt;, false &gt;</td></tr>
<tr class="separator:a44788dc656182b46ee0e9bf534eec4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefab617c271b247d871210e8c4142396" id="r_aefab617c271b247d871210e8c4142396"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a> = <a class="el" href="classbeast_1_1LockFreeStackIterator.html">LockFreeStackIterator</a>&lt; <a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt; Element, Tag &gt;, true &gt;</td></tr>
<tr class="separator:aefab617c271b247d871210e8c4142396"><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:a883b67af0ed5272cf0fb0ed5a979f7e4" id="r_a883b67af0ed5272cf0fb0ed5a979f7e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a883b67af0ed5272cf0fb0ed5a979f7e4">LockFreeStack</a> ()</td></tr>
<tr class="separator:a883b67af0ed5272cf0fb0ed5a979f7e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77913f72115155984e9341190bfc7310" id="r_a77913f72115155984e9341190bfc7310"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a77913f72115155984e9341190bfc7310">LockFreeStack</a> (<a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a> const &amp;)=delete</td></tr>
<tr class="separator:a77913f72115155984e9341190bfc7310"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d1a7d955ce61d2ac17ba991c88c7e80" id="r_a8d1a7d955ce61d2ac17ba991c88c7e80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a8d1a7d955ce61d2ac17ba991c88c7e80">operator=</a> (<a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a> const &amp;)=delete</td></tr>
<tr class="separator:a8d1a7d955ce61d2ac17ba991c88c7e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a856b461e4633192bae17a04906243e1b" id="r_a856b461e4633192bae17a04906243e1b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a856b461e4633192bae17a04906243e1b">empty</a> () const</td></tr>
<tr class="memdesc:a856b461e4633192bae17a04906243e1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the stack is empty. <br /></td></tr>
<tr class="separator:a856b461e4633192bae17a04906243e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20607ac776197f6e80db524e13737750" id="r_a20607ac776197f6e80db524e13737750"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a20607ac776197f6e80db524e13737750">push_front</a> (<a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a> *node)</td></tr>
<tr class="memdesc:a20607ac776197f6e80db524e13737750"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push a node onto the stack. <br /></td></tr>
<tr class="separator:a20607ac776197f6e80db524e13737750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62e709bb5c7bec338ffbf32585a7137c" id="r_a62e709bb5c7bec338ffbf32585a7137c"><td class="memItemLeft" align="right" valign="top">Element *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a62e709bb5c7bec338ffbf32585a7137c">pop_front</a> ()</td></tr>
<tr class="memdesc:a62e709bb5c7bec338ffbf32585a7137c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop an element off the stack. <br /></td></tr>
<tr class="separator:a62e709bb5c7bec338ffbf32585a7137c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a5e135680d24783ba57f13792d0a09f9e" id="r_a5e135680d24783ba57f13792d0a09f9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#a44788dc656182b46ee0e9bf534eec4c2">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a5e135680d24783ba57f13792d0a09f9e">begin</a> ()</td></tr>
<tr class="memdesc:a5e135680d24783ba57f13792d0a09f9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a forward iterator to the beginning or end of the stack. <br /></td></tr>
<tr class="separator:a5e135680d24783ba57f13792d0a09f9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8804f35965a95c9b5725491b5233a99" id="r_ab8804f35965a95c9b5725491b5233a99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#a44788dc656182b46ee0e9bf534eec4c2">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ab8804f35965a95c9b5725491b5233a99">end</a> ()</td></tr>
<tr class="separator:ab8804f35965a95c9b5725491b5233a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae066bdacd20a6f4f178fbcf25384f30f" id="r_ae066bdacd20a6f4f178fbcf25384f30f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ae066bdacd20a6f4f178fbcf25384f30f">begin</a> () const</td></tr>
<tr class="separator:ae066bdacd20a6f4f178fbcf25384f30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afae6af9923558333036a80dd1b01a2c8" id="r_afae6af9923558333036a80dd1b01a2c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#afae6af9923558333036a80dd1b01a2c8">end</a> () const</td></tr>
<tr class="separator:afae6af9923558333036a80dd1b01a2c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e0d6da45e9fe049347962d309204314" id="r_a5e0d6da45e9fe049347962d309204314"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a5e0d6da45e9fe049347962d309204314">cbegin</a> () const</td></tr>
<tr class="separator:a5e0d6da45e9fe049347962d309204314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05f4144c95b980440fa49b2e24dfddc2" id="r_a05f4144c95b980440fa49b2e24dfddc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#a05f4144c95b980440fa49b2e24dfddc2">cend</a> () const</td></tr>
<tr class="separator:a05f4144c95b980440fa49b2e24dfddc2"><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:ae85a67c34580718b970ddd6e6e464d1b" id="r_ae85a67c34580718b970ddd6e6e464d1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#ae85a67c34580718b970ddd6e6e464d1b">m_end</a></td></tr>
<tr class="separator:ae85a67c34580718b970ddd6e6e464d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef700416cc2ea924eb020e0be2ed63de" id="r_aef700416cc2ea924eb020e0be2ed63de"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; <a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1LockFreeStack.html#aef700416cc2ea924eb020e0be2ed63de">m_head</a></td></tr>
<tr class="separator:aef700416cc2ea924eb020e0be2ed63de"><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 Element, class Tag = void&gt;<br />
class beast::LockFreeStack&lt; Element, Tag &gt;</div><p>Multiple Producer, Multiple Consumer (MPMC) intrusive stack. </p>
<p>This stack is implemented using the same intrusive interface as <a class="el" href="classbeast_1_1List.html" title="Intrusive doubly linked list.">List</a>. All mutations are lock-free.</p>
<p>The caller is responsible for preventing the "ABA" problem: <a href="http://en.wikipedia.org/wiki/ABA_problem">http://en.wikipedia.org/wiki/ABA_problem</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Tag</td><td>A type name used to distinguish lists and nodes, for putting objects in multiple lists. If this parameter is omitted, the default tag is used. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00127">127</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a1e2bf8329b989a61a93798398dd915df" name="a1e2bf8329b989a61a93798398dd915df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e2bf8329b989a61a93798398dd915df">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::value_type = Element</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00155">155</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a54a6e87c5584596b73c7e4794073d124" name="a54a6e87c5584596b73c7e4794073d124"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54a6e87c5584596b73c7e4794073d124">&#9670;&#160;</a></span>pointer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::pointer = Element*</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00156">156</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a69d547559317ce53da3d193e27cd68be" name="a69d547559317ce53da3d193e27cd68be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69d547559317ce53da3d193e27cd68be">&#9670;&#160;</a></span>reference</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::reference = Element&amp;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00157">157</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="ab1c9f40e6c35c2384a880b0e14a0aa0d" name="ab1c9f40e6c35c2384a880b0e14a0aa0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1c9f40e6c35c2384a880b0e14a0aa0d">&#9670;&#160;</a></span>const_pointer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::const_pointer = Element const*</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00158">158</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="ac208bf5e265cf6e499c2431f529c7f02" name="ac208bf5e265cf6e499c2431f529c7f02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac208bf5e265cf6e499c2431f529c7f02">&#9670;&#160;</a></span>const_reference</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::const_reference = Element const&amp;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00159">159</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="ac61f4f5b0dc1bc269337f70e0460f061" name="ac61f4f5b0dc1bc269337f70e0460f061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac61f4f5b0dc1bc269337f70e0460f061">&#9670;&#160;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::size_type = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00160">160</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="acc69aefb629e0761668a99569c397d8e" name="acc69aefb629e0761668a99569c397d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc69aefb629e0761668a99569c397d8e">&#9670;&#160;</a></span>difference_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::difference_type = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/ptrdiff_t.html">std::ptrdiff_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00161">161</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a44788dc656182b46ee0e9bf534eec4c2" name="a44788dc656182b46ee0e9bf534eec4c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44788dc656182b46ee0e9bf534eec4c2">&#9670;&#160;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::iterator = <a class="el" href="classbeast_1_1LockFreeStackIterator.html">LockFreeStackIterator</a>&lt;<a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt;Element, Tag&gt;, false&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00162">162</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="aefab617c271b247d871210e8c4142396" name="aefab617c271b247d871210e8c4142396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefab617c271b247d871210e8c4142396">&#9670;&#160;</a></span>const_iterator</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::const_iterator = <a class="el" href="classbeast_1_1LockFreeStackIterator.html">LockFreeStackIterator</a>&lt;<a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt;Element, Tag&gt;, true&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00163">163</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a883b67af0ed5272cf0fb0ed5a979f7e4" name="a883b67af0ed5272cf0fb0ed5a979f7e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883b67af0ed5272cf0fb0ed5a979f7e4">&#9670;&#160;</a></span>LockFreeStack() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::LockFreeStack </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00166">166</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a77913f72115155984e9341190bfc7310" name="a77913f72115155984e9341190bfc7310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77913f72115155984e9341190bfc7310">&#9670;&#160;</a></span>LockFreeStack() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::LockFreeStack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt; Element, Tag &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8d1a7d955ce61d2ac17ba991c88c7e80" name="a8d1a7d955ce61d2ac17ba991c88c7e80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d1a7d955ce61d2ac17ba991c88c7e80">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a> &amp; <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1LockFreeStack.html">LockFreeStack</a>&lt; Element, Tag &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a856b461e4633192bae17a04906243e1b" name="a856b461e4633192bae17a04906243e1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a856b461e4633192bae17a04906243e1b">&#9670;&#160;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the stack is empty. </p>
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00176">176</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a20607ac776197f6e80db524e13737750" name="a20607ac776197f6e80db524e13737750"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20607ac776197f6e80db524e13737750">&#9670;&#160;</a></span>push_front()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::push_front </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a> *&#160;</td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Push a node onto the stack. </p>
<p>The caller is responsible for preventing the ABA problem. This operation is lock-free. Thread safety: Safe to call from any thread.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to push.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the stack was previously empty. If multiple threads are attempting to push, only one will receive <code>true</code>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00194">194</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a62e709bb5c7bec338ffbf32585a7137c" name="a62e709bb5c7bec338ffbf32585a7137c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62e709bb5c7bec338ffbf32585a7137c">&#9670;&#160;</a></span>pop_front()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname">Element * <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::pop_front </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pop an element off the stack. </p>
<p>The caller is responsible for preventing the ABA problem. This operation is lock-free. Thread safety: Safe to call from any thread.</p>
<dl class="section return"><dt>Returns</dt><dd>The element that was popped, or <code>nullptr</code> if the stack was empty. </dd></dl>
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00220">220</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a5e135680d24783ba57f13792d0a09f9e" name="a5e135680d24783ba57f13792d0a09f9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e135680d24783ba57f13792d0a09f9e">&#9670;&#160;</a></span>begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#a44788dc656182b46ee0e9bf534eec4c2">iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a forward iterator to the beginning or end of the stack. </p>
<p>Undefined behavior results if push_front or pop_front is called while an iteration is in progress. Thread safety: Caller is responsible for synchronization. </p>
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00245">245</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="ab8804f35965a95c9b5725491b5233a99" name="ab8804f35965a95c9b5725491b5233a99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8804f35965a95c9b5725491b5233a99">&#9670;&#160;</a></span>end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#a44788dc656182b46ee0e9bf534eec4c2">iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00251">251</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="ae066bdacd20a6f4f178fbcf25384f30f" name="ae066bdacd20a6f4f178fbcf25384f30f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae066bdacd20a6f4f178fbcf25384f30f">&#9670;&#160;</a></span>begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00257">257</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="afae6af9923558333036a80dd1b01a2c8" name="afae6af9923558333036a80dd1b01a2c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afae6af9923558333036a80dd1b01a2c8">&#9670;&#160;</a></span>end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00263">263</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a5e0d6da45e9fe049347962d309204314" name="a5e0d6da45e9fe049347962d309204314"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e0d6da45e9fe049347962d309204314">&#9670;&#160;</a></span>cbegin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::cbegin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00269">269</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="a05f4144c95b980440fa49b2e24dfddc2" name="a05f4144c95b980440fa49b2e24dfddc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05f4144c95b980440fa49b2e24dfddc2">&#9670;&#160;</a></span>cend()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack.html#aefab617c271b247d871210e8c4142396">const_iterator</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::cend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00275">275</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae85a67c34580718b970ddd6e6e464d1b" name="ae85a67c34580718b970ddd6e6e464d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae85a67c34580718b970ddd6e6e464d1b">&#9670;&#160;</a></span>m_end</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a> <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::m_end</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00282">282</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
<a id="aef700416cc2ea924eb020e0be2ed63de" name="aef700416cc2ea924eb020e0be2ed63de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef700416cc2ea924eb020e0be2ed63de">&#9670;&#160;</a></span>m_head</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Element , class Tag = void&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt;<a class="el" href="classbeast_1_1LockFreeStack_1_1Node.html">Node</a>*&gt; <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; Element, Tag &gt;::m_head</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LockFreeStack_8h_source.html#l00283">283</a> of file <a class="el" href="LockFreeStack_8h_source.html">LockFreeStack.h</a>.</p>
</div>
</div>
</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.8
</small></address>
</body>
</html>