ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 05:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1ThreadSafeQueue.html
manojsdoshi 3ded95240d deploy: 4ec11e692b
2021-12-17 19:04:33 +00:00

383 lines
19 KiB
HTML
Raw 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::ThreadSafeQueue&lt; T &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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1ThreadSafeQueue.html">ThreadSafeQueue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1ThreadSafeQueue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::ThreadSafeQueue&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Generic thread-safe queue with an optional maximum size Note, we can't use a lockfree queue here, since we need the ability to wait for an element to be added or removed from the queue.
<a href="classripple_1_1ThreadSafeQueue.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::ThreadSafeQueue&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1ThreadSafeQueue__coll__graph.png" border="0" usemap="#ripple_1_1ThreadSafeQueue_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1ThreadSafeQueue_3_01T_01_4_coll__map" id="ripple_1_1ThreadSafeQueue_3_01T_01_4_coll__map">
<area shape="rect" title="Generic thread&#45;safe queue with an optional maximum size Note, we can&#39;t use a lockfree queue here,..." alt="" coords="183,95,404,121"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="5,5,176,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="200,5,387,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="411,5,503,32"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9b7be76ee668f6eedd3ed40b5c79ec32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a9b7be76ee668f6eedd3ed40b5c79ec32">ThreadSafeQueue</a> (uint32_t maxSize)</td></tr>
<tr class="separator:a9b7be76ee668f6eedd3ed40b5c79ec32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38cec7f51acb38c050fe62d8cef00de6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a38cec7f51acb38c050fe62d8cef00de6">ThreadSafeQueue</a> ()=default</td></tr>
<tr class="memdesc:a38cec7f51acb38c050fe62d8cef00de6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a queue with no maximum size. <a href="classripple_1_1ThreadSafeQueue.html#a38cec7f51acb38c050fe62d8cef00de6">More...</a><br /></td></tr>
<tr class="separator:a38cec7f51acb38c050fe62d8cef00de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50bf551073518b6c5c918bcf5951f4b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a50bf551073518b6c5c918bcf5951f4b0">push</a> (T const &amp;elt)</td></tr>
<tr class="separator:a50bf551073518b6c5c918bcf5951f4b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a492d9a97f044e5e3ac630e7e2a81dfe7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a492d9a97f044e5e3ac630e7e2a81dfe7">push</a> (T &amp;&amp;elt)</td></tr>
<tr class="separator:a492d9a97f044e5e3ac630e7e2a81dfe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00414646e07c072c60e3bebe30a656b8"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a00414646e07c072c60e3bebe30a656b8">pop</a> ()</td></tr>
<tr class="separator:a00414646e07c072c60e3bebe30a656b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a92d802bf0eca1690ef1687313c298cfc"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/queue.html">std::queue</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a92d802bf0eca1690ef1687313c298cfc">queue_</a></td></tr>
<tr class="separator:a92d802bf0eca1690ef1687313c298cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c64cc5a0321aaef4e841db09824f1f5"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a0c64cc5a0321aaef4e841db09824f1f5">m_</a></td></tr>
<tr class="separator:a0c64cc5a0321aaef4e841db09824f1f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58a9d8247eb99c9c04e400c9680a3119"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#a58a9d8247eb99c9c04e400c9680a3119">cv_</a></td></tr>
<tr class="separator:a58a9d8247eb99c9c04e400c9680a3119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9c6b00c5f0185788b46ea36b82bad1d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ThreadSafeQueue.html#ad9c6b00c5f0185788b46ea36b82bad1d">maxSize_</a></td></tr>
<tr class="separator:ad9c6b00c5f0185788b46ea36b82bad1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class ripple::ThreadSafeQueue&lt; T &gt;</h3>
<p>Generic thread-safe queue with an optional maximum size Note, we can't use a lockfree queue here, since we need the ability to wait for an element to be added or removed from the queue. </p>
<p>These waits are blocking calls. </p>
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00115">115</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9b7be76ee668f6eedd3ed40b5c79ec32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b7be76ee668f6eedd3ed40b5c79ec32">&#9670;&nbsp;</a></span>ThreadSafeQueue() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::<a class="el" href="classripple_1_1ThreadSafeQueue.html">ThreadSafeQueue</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>maxSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxSize</td><td>maximum size of the queue. Calls that would cause the queue to exceed this size will block until free space is available </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00126">126</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="a38cec7f51acb38c050fe62d8cef00de6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38cec7f51acb38c050fe62d8cef00de6">&#9670;&nbsp;</a></span>ThreadSafeQueue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::<a class="el" href="classripple_1_1ThreadSafeQueue.html">ThreadSafeQueue</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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a queue with no maximum size. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a50bf551073518b6c5c918bcf5951f4b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50bf551073518b6c5c918bcf5951f4b0">&#9670;&nbsp;</a></span>push() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::push </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>elt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elt</td><td>element to push onto queue if maxSize is set, this method will block until free space is available </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00136">136</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="a492d9a97f044e5e3ac630e7e2a81dfe7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a492d9a97f044e5e3ac630e7e2a81dfe7">&#9670;&nbsp;</a></span>push() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::push </td>
<td>(</td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>elt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elt</td><td>element to push onto queue. elt is moved from if maxSize is set, this method will block until free space is available </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00149">149</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="a00414646e07c072c60e3bebe30a656b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00414646e07c072c60e3bebe30a656b8">&#9670;&nbsp;</a></span>pop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>element popped from queue. Will block until queue is non-empty </dd></dl>
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00161">161</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a92d802bf0eca1690ef1687313c298cfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92d802bf0eca1690ef1687313c298cfc">&#9670;&nbsp;</a></span>queue_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &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/container/queue.html">std::queue</a>&lt;T&gt; <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::queue_</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="ETLHelpers_8h_source.html#l00117">117</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="a0c64cc5a0321aaef4e841db09824f1f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c64cc5a0321aaef4e841db09824f1f5">&#9670;&nbsp;</a></span>m_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &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/thread/mutex.html">std::mutex</a> <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::m_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ETLHelpers_8h_source.html#l00119">119</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="a58a9d8247eb99c9c04e400c9680a3119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58a9d8247eb99c9c04e400c9680a3119">&#9670;&nbsp;</a></span>cv_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &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/thread/condition_variable.html">std::condition_variable</a> <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::cv_</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="ETLHelpers_8h_source.html#l00120">120</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
<a id="ad9c6b00c5f0185788b46ea36b82bad1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9c6b00c5f0185788b46ea36b82bad1d">&#9670;&nbsp;</a></span>maxSize_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &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/utility/optional.html">std::optional</a>&lt;uint32_t&gt; <a class="el" href="classripple_1_1ThreadSafeQueue.html">ripple::ThreadSafeQueue</a>&lt; T &gt;::maxSize_</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="ETLHelpers_8h_source.html#l00121">121</a> of file <a class="el" href="ETLHelpers_8h_source.html">ETLHelpers.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink