Files
rippled/TaskQueue_8cpp_source.html
2020-09-22 22:46:01 +00:00

166 lines
20 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">
<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: TaskQueue.cpp 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 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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_ceb6d1bc218d15504336f945ff1322da.html">nodestore</a></li><li class="navelem"><a class="el" href="dir_1eae1e3c362aa357dbf8694343222a03.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">TaskQueue.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2019 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;ripple/nodestore/impl/TaskQueue.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span>NodeStore {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1TaskQueue.html#ae59691f4ad2a8f7c6cd2be7c1fc772d1"> 27</a></span>&#160;<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ae59691f4ad2a8f7c6cd2be7c1fc772d1">TaskQueue::TaskQueue</a>(<a class="code" href="classripple_1_1Stoppable.html">Stoppable</a>&amp; parent)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; : <a class="code" href="classripple_1_1Stoppable.html">Stoppable</a>(<span class="stringliteral">&quot;TaskQueue&quot;</span>, parent)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; , workers_(*this, nullptr, <span class="stringliteral">&quot;Shard store taskQueue&quot;</span>, 1)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1TaskQueue.html#a621ef5d4bf00e8499bef58c8789686c3"> 34</a></span>&#160;<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#a621ef5d4bf00e8499bef58c8789686c3">TaskQueue::onStop</a>()</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ad7eb2cb13ace6f9a38b211e54b9cd85f">workers_</a>.<a class="code" href="classripple_1_1Workers.html#a57ae4066b756be97dd589a72aebc5020">pauseAllThreadsAndWait</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classripple_1_1Stoppable.html#a65a95f9c14637491df60d3a07518fa09">stopped</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1TaskQueue.html#adfc47d4a87f6cfe28c4885d4318b87ff"> 41</a></span>&#160;<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#adfc47d4a87f6cfe28c4885d4318b87ff">TaskQueue::addTask</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>()&gt; task)</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#a8175de06ffcfceb698815efe924b7bcc">mutex_</a>};</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ade3310509bcac3cdf02521df9f9d2c34">tasks_</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/queue/emplace.html">emplace</a>(std::move(task));</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ad7eb2cb13ace6f9a38b211e54b9cd85f">workers_</a>.<a class="code" href="classripple_1_1Workers.html#aa65a05362bb7c77d7679cefce91a1514">addTask</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1TaskQueue.html#adcd8d9fd3d2912c2de3042b982de9b86"> 50</a></span>&#160;<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#adcd8d9fd3d2912c2de3042b982de9b86">TaskQueue::processTask</a>(<span class="keywordtype">int</span> instance)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void()&gt; task;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#a8175de06ffcfceb698815efe924b7bcc">mutex_</a>};</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; assert(!<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ade3310509bcac3cdf02521df9f9d2c34">tasks_</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/queue/empty.html">empty</a>());</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; task = std::move(<a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ade3310509bcac3cdf02521df9f9d2c34">tasks_</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/queue/front.html">front</a>());</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1TaskQueue.html#ade3310509bcac3cdf02521df9f9d2c34">tasks_</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/queue/pop.html">pop</a>();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; task();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;}</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;} <span class="comment">// namespace NodeStore</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1Stoppable_html_a65a95f9c14637491df60d3a07518fa09"><div class="ttname"><a href="classripple_1_1Stoppable.html#a65a95f9c14637491df60d3a07518fa09">ripple::Stoppable::stopped</a></div><div class="ttdeci">void stopped()</div><div class="ttdoc">Called by derived classes to indicate that the stoppable has stopped.</div><div class="ttdef"><b>Definition:</b> <a href="Stoppable_8cpp_source.html#l00072">Stoppable.cpp:72</a></div></div>
<div class="ttc" id="aemplace_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/queue/emplace.html">std::queue::emplace</a></div><div class="ttdeci">T emplace(T... args)</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_ad7eb2cb13ace6f9a38b211e54b9cd85f"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#ad7eb2cb13ace6f9a38b211e54b9cd85f">ripple::NodeStore::TaskQueue::workers_</a></div><div class="ttdeci">Workers workers_</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8h_source.html#l00049">TaskQueue.h:49</a></div></div>
<div class="ttc" id="alock_guard_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_adcd8d9fd3d2912c2de3042b982de9b86"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#adcd8d9fd3d2912c2de3042b982de9b86">ripple::NodeStore::TaskQueue::processTask</a></div><div class="ttdeci">void processTask(int instance) override</div><div class="ttdoc">Perform a task.</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8cpp_source.html#l00050">TaskQueue.cpp:50</a></div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_ade3310509bcac3cdf02521df9f9d2c34"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#ade3310509bcac3cdf02521df9f9d2c34">ripple::NodeStore::TaskQueue::tasks_</a></div><div class="ttdeci">std::queue&lt; std::function&lt; void()&gt; &gt; tasks_</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8h_source.html#l00050">TaskQueue.h:50</a></div></div>
<div class="ttc" id="afront_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/queue/front.html">std::queue::front</a></div><div class="ttdeci">T front(T... args)</div></div>
<div class="ttc" id="aclassripple_1_1Stoppable_html"><div class="ttname"><a href="classripple_1_1Stoppable.html">ripple::Stoppable</a></div><div class="ttdoc">Provides an interface for starting and stopping.</div><div class="ttdef"><b>Definition:</b> <a href="Stoppable_8h_source.html#l00201">Stoppable.h:201</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_adfc47d4a87f6cfe28c4885d4318b87ff"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#adfc47d4a87f6cfe28c4885d4318b87ff">ripple::NodeStore::TaskQueue::addTask</a></div><div class="ttdeci">void addTask(std::function&lt; void()&gt; task)</div><div class="ttdoc">Adds a task to the queue.</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8cpp_source.html#l00041">TaskQueue.cpp:41</a></div></div>
<div class="ttc" id="apop_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/queue/pop.html">std::queue::pop</a></div><div class="ttdeci">T pop(T... args)</div></div>
<div class="ttc" id="aclassripple_1_1Workers_html_a57ae4066b756be97dd589a72aebc5020"><div class="ttname"><a href="classripple_1_1Workers.html#a57ae4066b756be97dd589a72aebc5020">ripple::Workers::pauseAllThreadsAndWait</a></div><div class="ttdeci">void pauseAllThreadsAndWait()</div><div class="ttdoc">Pause all threads and wait until they are paused.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8cpp_source.html#l00114">Workers.cpp:114</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_ae59691f4ad2a8f7c6cd2be7c1fc772d1"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#ae59691f4ad2a8f7c6cd2be7c1fc772d1">ripple::NodeStore::TaskQueue::TaskQueue</a></div><div class="ttdeci">TaskQueue(Stoppable &amp;parent)</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8cpp_source.html#l00027">TaskQueue.cpp:27</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_a621ef5d4bf00e8499bef58c8789686c3"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#a621ef5d4bf00e8499bef58c8789686c3">ripple::NodeStore::TaskQueue::onStop</a></div><div class="ttdeci">void onStop() override</div><div class="ttdoc">Override called when the stop notification is issued.</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8cpp_source.html#l00034">TaskQueue.cpp:34</a></div></div>
<div class="ttc" id="acassert_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a></div></div>
<div class="ttc" id="aclassripple_1_1Workers_html_aa65a05362bb7c77d7679cefce91a1514"><div class="ttname"><a href="classripple_1_1Workers.html#aa65a05362bb7c77d7679cefce91a1514">ripple::Workers::addTask</a></div><div class="ttdeci">void addTask()</div><div class="ttdoc">Add a task to be performed.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8cpp_source.html#l00126">Workers.cpp:126</a></div></div>
<div class="ttc" id="aempty_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/queue/empty.html">std::queue::empty</a></div><div class="ttdeci">T empty(T... args)</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1TaskQueue_html_a8175de06ffcfceb698815efe924b7bcc"><div class="ttname"><a href="classripple_1_1NodeStore_1_1TaskQueue.html#a8175de06ffcfceb698815efe924b7bcc">ripple::NodeStore::TaskQueue::mutex_</a></div><div class="ttdeci">std::mutex mutex_</div><div class="ttdef"><b>Definition:</b> <a href="TaskQueue_8h_source.html#l00048">TaskQueue.h:48</a></div></div>
<!-- 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>