ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 19:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 1a8eb5e6e3

Browse Source
This commit is contained in:
manojsdoshi
2022-03-11 23:48:43 +00:00
parent 33ee5a435d
commit 5f48f33f84
1856 changed files with 55639 additions and 53603 deletions
Download Patch File Download Diff File Expand all files Collapse all files

419
JobQueue_8h_source.html
View File

@@ -164,7 +164,7 @@ $(function() {
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <a class="code" href="classripple_1_1JobQueue_1_1Coro.html#a035344c995eb7c257f15cf844a2bf913">join</a>();</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; };</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#af362dbf1c55118ae846aa642c8816aab"> 141</a></span>&#160; <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">JobFunction</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void(<a class="code" href="classripple_1_1Job.html">Job</a>&amp;)&gt;;</div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#abcec6f40fa8a9f756ffcec562b68475d"> 141</a></span>&#160; <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">JobFunction</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void()&gt;;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#ad2e2d101e0ab78fb09e321422589d0b9">JobQueue</a>(</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordtype">int</span> threadCount,</div>
@@ -177,7 +177,7 @@ $(function() {
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">template</span> &lt;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keyword">typename</span> JobHandler,</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="keyword">typename</span> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same</a>&lt;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; decltype(std::declval&lt;JobHandler&amp;&amp;&gt;()(std::declval&lt;Job&amp;&gt;())),</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; decltype(std::declval&lt;JobHandler&amp;&amp;&gt;()()),</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordtype">void</span>&gt;::value&gt;&gt;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#af5e34187d55aa58e551dc196aaf1ec25"> 166</a></span>&#160; <a class="code" href="classripple_1_1JobQueue.html#af5e34187d55aa58e551dc196aaf1ec25">addJob</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name, JobHandler&amp;&amp; jobHandler)</div>
@@ -256,288 +256,267 @@ $(function() {
<div class="line"><a name="l00259"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a3cda8b303a0f13c8bc27de6093ca6bf1"> 259</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classripple_1_1JobQueue.html#a3cda8b303a0f13c8bc27de6093ca6bf1">nSuspend_</a> = 0;</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; </div>
<div class="line"><a name="l00261"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a60010e2872164e7be427470efb0797e0"> 261</a></span>&#160; <a class="code" href="classripple_1_1Workers.html">Workers</a> <a class="code" href="classripple_1_1JobQueue.html#a60010e2872164e7be427470efb0797e0">m_workers</a>;</div>
<div class="line"><a name="l00262"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a9745e6fb4f8b6838e8dba71024232882"> 262</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">Job::CancelCallback</a> <a class="code" href="classripple_1_1JobQueue.html#a9745e6fb4f8b6838e8dba71024232882">m_cancelCallback</a>;</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; </div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="comment">// Statistics tracking</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0"> 265</a></span>&#160; <a class="code" href="classripple_1_1perf_1_1PerfLog.html">perf::PerfLog</a>&amp; <a class="code" href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0">perfLog_</a>;</div>
<div class="line"><a name="l00266"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50"> 266</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">beast::insight::Collector::ptr</a> <a class="code" href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50">m_collector</a>;</div>
<div class="line"><a name="l00267"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4"> 267</a></span>&#160; <a class="code" href="classbeast_1_1insight_1_1Gauge.html">beast::insight::Gauge</a> <a class="code" href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4">job_count</a>;</div>
<div class="line"><a name="l00268"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1"> 268</a></span>&#160; <a class="code" href="classbeast_1_1insight_1_1Hook.html">beast::insight::Hook</a> <a class="code" href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1">hook</a>;</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; </div>
<div class="line"><a name="l00270"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad"> 270</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a> <a class="code" href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad">cv_</a>;</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; </div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a82df9d9e8400ad01e46cdab9c4da3cf7">collect</a>();</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160; <a class="code" href="structripple_1_1JobTypeData.html">JobTypeData</a>&amp;</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a64c1e56256e2e60a5a0b2d0c32dc3a75">getJobTypeData</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; <span class="comment">// Adds a reference counted job to the JobQueue.</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; <span class="comment">// param type The type of job.</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="comment">// param name Name of the job.</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; <span class="comment">// param func std::function with signature void (Job&amp;). Called when the</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <span class="comment">// job is executed.</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; <span class="comment">// return true if func added to queue.</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#aa5498338b13efc92f47517a44990b6ff">addRefCountedJob</a>(</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; <a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type,</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name,</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">JobFunction</a> <span class="keyword">const</span>&amp; func);</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; </div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; <span class="comment">// Signals an added Job for processing.</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; <span class="comment">// The JobType must be valid.</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; <span class="comment">// The Job must exist in mJobSet.</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; <span class="comment">// The Job must not have previously been queued.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; <span class="comment">// Count of waiting jobs of that type will be incremented.</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <span class="comment">// If JobQueue exists, and has at least one thread, Job will eventually</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; <span class="comment">// run.</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; <span class="comment">// The calling thread owns the JobLock</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#abbe39ec5295b5704fc44414936f0d31b">queueJob</a>(<a class="code" href="classripple_1_1Job.html">Job</a> <span class="keyword">const</span>&amp; job, <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard&lt;std::mutex&gt;</a> <span class="keyword">const</span>&amp; lock);</div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160; </div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; <span class="comment">// Returns the next Job we should run now.</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; <span class="comment">// RunnableJob:</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; <span class="comment">// A Job in the JobSet whose slots count for its type is greater than zero.</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; <span class="comment">// mJobSet must not be empty.</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="comment">// mJobSet holds at least one RunnableJob</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="comment">// job is a valid Job object.</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; <span class="comment">// job is removed from mJobQueue.</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <span class="comment">// Waiting job count of its type is decremented</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; <span class="comment">// Running job count of its type is incremented</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; <span class="comment">// The calling thread owns the JobLock</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#aea4a8725f6acf0a4840679526754c469">getNextJob</a>(<a class="code" href="classripple_1_1Job.html">Job</a>&amp; job);</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; </div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="comment">// Indicates that a running Job has completed its task.</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; <span class="comment">// Job must not exist in mJobSet.</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; <span class="comment">// The JobType must not be invalid.</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; <span class="comment">// Statistics tracking</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0"> 264</a></span>&#160; <a class="code" href="classripple_1_1perf_1_1PerfLog.html">perf::PerfLog</a>&amp; <a class="code" href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0">perfLog_</a>;</div>
<div class="line"><a name="l00265"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50"> 265</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">beast::insight::Collector::ptr</a> <a class="code" href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50">m_collector</a>;</div>
<div class="line"><a name="l00266"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4"> 266</a></span>&#160; <a class="code" href="classbeast_1_1insight_1_1Gauge.html">beast::insight::Gauge</a> <a class="code" href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4">job_count</a>;</div>
<div class="line"><a name="l00267"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1"> 267</a></span>&#160; <a class="code" href="classbeast_1_1insight_1_1Hook.html">beast::insight::Hook</a> <a class="code" href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1">hook</a>;</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; </div>
<div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad"> 269</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a> <a class="code" href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad">cv_</a>;</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; </div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a82df9d9e8400ad01e46cdab9c4da3cf7">collect</a>();</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; <a class="code" href="structripple_1_1JobTypeData.html">JobTypeData</a>&amp;</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a64c1e56256e2e60a5a0b2d0c32dc3a75">getJobTypeData</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; </div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; <span class="comment">// Adds a reference counted job to the JobQueue.</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160; <span class="comment">// param type The type of job.</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; <span class="comment">// param name Name of the job.</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="comment">// param func std::function with signature void (Job&amp;). Called when the</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; <span class="comment">// job is executed.</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="comment">// return true if func added to queue.</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#aa5498338b13efc92f47517a44990b6ff">addRefCountedJob</a>(</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; <a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type,</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name,</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">JobFunction</a> <span class="keyword">const</span>&amp; func);</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; </div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; <span class="comment">// Returns the next Job we should run now.</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; <span class="comment">// RunnableJob:</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; <span class="comment">// A Job in the JobSet whose slots count for its type is greater than zero.</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; <span class="comment">// mJobSet must not be empty.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <span class="comment">// mJobSet holds at least one RunnableJob</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <span class="comment">// job is a valid Job object.</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; <span class="comment">// job is removed from mJobQueue.</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; <span class="comment">// Waiting job count of its type is decremented</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; <span class="comment">// Running job count of its type is incremented</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; <span class="comment">// The calling thread owns the JobLock</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#aea4a8725f6acf0a4840679526754c469">getNextJob</a>(<a class="code" href="classripple_1_1Job.html">Job</a>&amp; job);</div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; </div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; <span class="comment">// Indicates that a running Job has completed its task.</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; <span class="comment">// Job must not exist in mJobSet.</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; <span class="comment">// The JobType must not be invalid.</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; <span class="comment">// The running count of that JobType is decremented</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="comment">// A new task is signaled if there are more waiting Jobs than the limit, if</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; <span class="comment">// any.</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; <span class="comment">// &lt;none&gt;</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#ad85b8901e4cab468c6a57a3ee5fee60d">finishJob</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; <span class="comment">// Runs the next appropriate waiting Job.</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; <span class="comment">// A RunnableJob must exist in the JobSet</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; <span class="comment">// The chosen RunnableJob will have Job::doJob() called.</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; <span class="comment">// The running count of that JobType is decremented</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; <span class="comment">// A new task is signaled if there are more waiting Jobs than the limit, if</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; <span class="comment">// any.</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160; <span class="comment">// &lt;none&gt;</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#ad85b8901e4cab468c6a57a3ee5fee60d">finishJob</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; </div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160; <span class="comment">// Runs the next appropriate waiting Job.</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160; <span class="comment">// Pre-conditions:</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; <span class="comment">// A RunnableJob must exist in the JobSet</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; <span class="comment">// Post-conditions:</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; <span class="comment">// The chosen RunnableJob will have Job::doJob() called.</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; <span class="comment">// &lt;none&gt;</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#ace46ddb99e1da2748bc42a4243c5a187">processTask</a>(<span class="keywordtype">int</span> instance) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; </div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <span class="comment">// Returns the limit of running jobs for the given job type.</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; <span class="comment">// For jobs with no limit, we return the largest int. Hopefully that</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; <span class="comment">// will be enough.</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; <span class="keywordtype">int</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a14cf30fe234ed1b12021fba996444957">getJobLimit</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;};</div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; </div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="comment"> An RPC command is received and is handled via ServerHandler(HTTP) or</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"> Handler(websocket), depending on the connection type. The handler then calls</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> the JobQueue::postCoro() method to create a coroutine and run it at a later</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> point. This frees up the handler thread and allows it to continue handling</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="comment"> other requests while the RPC command completes its work asynchronously.</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;<span class="comment"> postCoro() creates a Coro object. When the Coro ctor is called, and its</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="comment"> coro_ member is initialized (a boost::coroutines::pull_type), execution</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="comment"> automatically passes to the coroutine, which we don&#39;t want at this point,</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="comment"> since we are still in the handler thread context. It&#39;s important to note</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="comment"> here that construction of a boost pull_type automatically passes execution to</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="comment"> the coroutine. A pull_type object automatically generates a push_type that is</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="comment"> passed as a parameter (do_yield) in the signature of the function the</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160;<span class="comment"> pull_type was created with. This function is immediately called during coro_</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;<span class="comment"> construction and within it, Coro::yield_ is assigned the push_type</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160;<span class="comment"> parameter (do_yield) address and called (yield()) so we can return execution</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160;<span class="comment"> back to the caller&#39;s stack.</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;<span class="comment"> postCoro() then calls Coro::post(), which schedules a job on the job</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160;<span class="comment"> queue to continue execution of the coroutine in a JobQueue worker thread at</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="comment"> some later time. When the job runs, we lock on the Coro::mutex_ and call</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> coro_ which continues where we had left off. Since we the last thing we did</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"> in coro_ was call yield(), the next thing we continue with is calling the</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> function param f, that was passed into Coro ctor. It is within this</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> function body that the caller specifies what he would like to do while</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> running in the coroutine and allow them to suspend and resume execution.</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;<span class="comment"> A task that relies on other events to complete, such as path finding, calls</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<span class="comment"> Coro::yield() to suspend its execution while waiting on those events to</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;<span class="comment"> complete and continue when signaled via the Coro::post() method.</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> There is a potential race condition that exists here where post() can get</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"> called before yield() after f is called. Technically the problem only occurs</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> if the job that post() scheduled is executed before yield() is called.</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"> If the post() job were to be executed before yield(), undefined behavior</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> would occur. The lock ensures that coro_ is not called again until we exit</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> the coroutine. At which point a scheduled resume() job waiting on the lock</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160;<span class="comment"> would gain entry, harmlessly call coro_ and immediately return as we have</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="comment"> already completed the coroutine.</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160;<span class="comment"> The race condition occurs as follows:</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160;<span class="comment"> 1- The coroutine is running.</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;<span class="comment"> 2- The coroutine is about to suspend, but before it can do so, it must</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160;<span class="comment"> arrange for some event to wake it up.</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="comment"> 3- The coroutine arranges for some event to wake it up.</span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<span class="comment"> 4- Before the coroutine can suspend, that event occurs and the</span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160;<span class="comment"> resumption of the coroutine is scheduled on the job queue. 5- Again, before</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;<span class="comment"> the coroutine can suspend, the resumption of the coroutine is dispatched. 6-</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160;<span class="comment"> Again, before the coroutine can suspend, the resumption code runs the</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="comment"> coroutine.</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="comment"> The coroutine is now running in two threads.</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160;<span class="comment"> The lock prevents this from happening as step 6 will block until the</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="comment"> lock is released which only happens after the coroutine completes.</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; </div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; </div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="preprocessor">#include &lt;ripple/core/Coro.ipp&gt;</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; </div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; </div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> F&gt;</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;JobQueue::Coro&gt;</a></div>
<div class="line"><a name="l00429"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb"> 429</a></span>&#160;<a class="code" href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb">JobQueue::postCoro</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> t, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name, F&amp;&amp; f)</div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160;{</div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; <span class="comment">/* First param is a detail type to make construction private.</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;<span class="comment"> Last param is the function the coroutine runs. Signature of</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160;<span class="comment"> void(std::shared_ptr&lt;Coro&gt;).</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; <span class="keyword">auto</span> coro = std::make_shared&lt;Coro&gt;(</div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; <a class="code" href="structripple_1_1Coro__create__t.html">Coro_create_t</a>{}, *<span class="keyword">this</span>, t, name, std::forward&lt;F&gt;(f));</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; <span class="keywordflow">if</span> (!coro-&gt;post())</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; {</div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; <span class="comment">// The Coro was not successfully posted. Disable it so it&#39;s destructor</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; <span class="comment">// can run with no negative side effects. Then destroy it.</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; coro-&gt;expectEarlyExit();</div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; coro.reset();</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; }</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <span class="keywordflow">return</span> coro;</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;}</div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160; </div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; </div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; <span class="comment">// Invariants:</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; <span class="comment">// &lt;none&gt;</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#ace46ddb99e1da2748bc42a4243c5a187">processTask</a>(<span class="keywordtype">int</span> instance) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; </div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; <span class="comment">// Returns the limit of running jobs for the given job type.</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160; <span class="comment">// For jobs with no limit, we return the largest int. Hopefully that</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; <span class="comment">// will be enough.</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <span class="keywordtype">int</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; <a class="code" href="classripple_1_1JobQueue.html#a14cf30fe234ed1b12021fba996444957">getJobLimit</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type);</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;};</div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; </div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="comment"> An RPC command is received and is handled via ServerHandler(HTTP) or</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;<span class="comment"> Handler(websocket), depending on the connection type. The handler then calls</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;<span class="comment"> the JobQueue::postCoro() method to create a coroutine and run it at a later</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="comment"> point. This frees up the handler thread and allows it to continue handling</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="comment"> other requests while the RPC command completes its work asynchronously.</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="comment"> postCoro() creates a Coro object. When the Coro ctor is called, and its</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="comment"> coro_ member is initialized (a boost::coroutines::pull_type), execution</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;<span class="comment"> automatically passes to the coroutine, which we don&#39;t want at this point,</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="comment"> since we are still in the handler thread context. It&#39;s important to note</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;<span class="comment"> here that construction of a boost pull_type automatically passes execution to</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;<span class="comment"> the coroutine. A pull_type object automatically generates a push_type that is</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160;<span class="comment"> passed as a parameter (do_yield) in the signature of the function the</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;<span class="comment"> pull_type was created with. This function is immediately called during coro_</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;<span class="comment"> construction and within it, Coro::yield_ is assigned the push_type</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;<span class="comment"> parameter (do_yield) address and called (yield()) so we can return execution</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;<span class="comment"> back to the caller&#39;s stack.</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="comment"> postCoro() then calls Coro::post(), which schedules a job on the job</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"> queue to continue execution of the coroutine in a JobQueue worker thread at</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> some later time. When the job runs, we lock on the Coro::mutex_ and call</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> coro_ which continues where we had left off. Since we the last thing we did</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="comment"> in coro_ was call yield(), the next thing we continue with is calling the</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="comment"> function param f, that was passed into Coro ctor. It is within this</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;<span class="comment"> function body that the caller specifies what he would like to do while</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="comment"> running in the coroutine and allow them to suspend and resume execution.</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="comment"> A task that relies on other events to complete, such as path finding, calls</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="comment"> Coro::yield() to suspend its execution while waiting on those events to</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="comment"> complete and continue when signaled via the Coro::post() method.</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="comment"> There is a potential race condition that exists here where post() can get</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160;<span class="comment"> called before yield() after f is called. Technically the problem only occurs</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;<span class="comment"> if the job that post() scheduled is executed before yield() is called.</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160;<span class="comment"> If the post() job were to be executed before yield(), undefined behavior</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160;<span class="comment"> would occur. The lock ensures that coro_ is not called again until we exit</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;<span class="comment"> the coroutine. At which point a scheduled resume() job waiting on the lock</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;<span class="comment"> would gain entry, harmlessly call coro_ and immediately return as we have</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160;<span class="comment"> already completed the coroutine.</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> The race condition occurs as follows:</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> 1- The coroutine is running.</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> 2- The coroutine is about to suspend, but before it can do so, it must</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> arrange for some event to wake it up.</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;<span class="comment"> 3- The coroutine arranges for some event to wake it up.</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<span class="comment"> 4- Before the coroutine can suspend, that event occurs and the</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;<span class="comment"> resumption of the coroutine is scheduled on the job queue. 5- Again, before</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"> the coroutine can suspend, the resumption of the coroutine is dispatched. 6-</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> Again, before the coroutine can suspend, the resumption code runs the</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"> coroutine.</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> The coroutine is now running in two threads.</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> The lock prevents this from happening as step 6 will block until the</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> lock is released which only happens after the coroutine completes.</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160; </div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; </div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160;<span class="preprocessor">#include &lt;ripple/core/Coro.ipp&gt;</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; </div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; </div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> F&gt;</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;JobQueue::Coro&gt;</a></div>
<div class="line"><a name="l00411"></a><span class="lineno"><a class="line" href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb"> 411</a></span>&#160;<a class="code" href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb">JobQueue::postCoro</a>(<a class="code" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> t, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name, F&amp;&amp; f)</div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;{</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; <span class="comment">/* First param is a detail type to make construction private.</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="comment"> Last param is the function the coroutine runs. Signature of</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="comment"> void(std::shared_ptr&lt;Coro&gt;).</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; <span class="keyword">auto</span> coro = std::make_shared&lt;Coro&gt;(</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; <a class="code" href="structripple_1_1Coro__create__t.html">Coro_create_t</a>{}, *<span class="keyword">this</span>, t, name, std::forward&lt;F&gt;(f));</div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; <span class="keywordflow">if</span> (!coro-&gt;post())</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; {</div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; <span class="comment">// The Coro was not successfully posted. Disable it so it&#39;s destructor</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; <span class="comment">// can run with no negative side effects. Then destroy it.</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160; coro-&gt;expectEarlyExit();</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; coro.reset();</div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; }</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; <span class="keywordflow">return</span> coro;</div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;}</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; </div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; </div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1Coro__create__t_html_ac5376d52b4d7b9726966c9fe953c334b"><div class="ttname"><a href="structripple_1_1Coro__create__t.html#ac5376d52b4d7b9726966c9fe953c334b">ripple::Coro_create_t::Coro_create_t</a></div><div class="ttdeci">Coro_create_t()=default</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ad85b8901e4cab468c6a57a3ee5fee60d"><div class="ttname"><a href="classripple_1_1JobQueue.html#ad85b8901e4cab468c6a57a3ee5fee60d">ripple::JobQueue::finishJob</a></div><div class="ttdeci">void finishJob(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00343">JobQueue.cpp:343</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ad85b8901e4cab468c6a57a3ee5fee60d"><div class="ttname"><a href="classripple_1_1JobQueue.html#ad85b8901e4cab468c6a57a3ee5fee60d">ripple::JobQueue::finishJob</a></div><div class="ttdeci">void finishJob(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00332">JobQueue.cpp:332</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aac6bff41a411723294b2cced7d79f994"><div class="ttname"><a href="classripple_1_1JobQueue.html#aac6bff41a411723294b2cced7d79f994">ripple::JobQueue::m_jobSet</a></div><div class="ttdeci">std::set&lt; Job &gt; m_jobSet</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00248">JobQueue.h:248</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a3cda8b303a0f13c8bc27de6093ca6bf1"><div class="ttname"><a href="classripple_1_1JobQueue.html#a3cda8b303a0f13c8bc27de6093ca6bf1">ripple::JobQueue::nSuspend_</a></div><div class="ttdeci">int nSuspend_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00259">JobQueue.h:259</a></div></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt; Collector &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ad2e2d101e0ab78fb09e321422589d0b9"><div class="ttname"><a href="classripple_1_1JobQueue.html#ad2e2d101e0ab78fb09e321422589d0b9">ripple::JobQueue::JobQueue</a></div><div class="ttdeci">JobQueue(int threadCount, beast::insight::Collector::ptr const &amp;collector, beast::Journal journal, Logs &amp;logs, perf::PerfLog &amp;perfLog)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00027">JobQueue.cpp:27</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a1ccc14aacdd6450e2ee29ad1eb71b6cb"><div class="ttname"><a href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb">ripple::JobQueue::postCoro</a></div><div class="ttdeci">std::shared_ptr&lt; Coro &gt; postCoro(JobType t, std::string const &amp;name, F &amp;&amp;f)</div><div class="ttdoc">Creates a coroutine and adds a job to the queue which will run it.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00429">JobQueue.h:429</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a1ccc14aacdd6450e2ee29ad1eb71b6cb"><div class="ttname"><a href="classripple_1_1JobQueue.html#a1ccc14aacdd6450e2ee29ad1eb71b6cb">ripple::JobQueue::postCoro</a></div><div class="ttdeci">std::shared_ptr&lt; Coro &gt; postCoro(JobType t, std::string const &amp;name, F &amp;&amp;f)</div><div class="ttdoc">Creates a coroutine and adds a job to the queue which will run it.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00411">JobQueue.h:411</a></div></div>
<div class="ttc" id="aclassripple_1_1Logs_html"><div class="ttname"><a href="classripple_1_1Logs.html">ripple::Logs</a></div><div class="ttdoc">Manages partitions for logging.</div><div class="ttdef"><b>Definition:</b> <a href="Log_8h_source.html#l00048">Log.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a7b83fd8b286c29a56975e32284244db0"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a7b83fd8b286c29a56975e32284244db0">ripple::JobQueue::Coro::post</a></div><div class="ttdeci">bool post()</div><div class="ttdoc">Schedule coroutine execution.</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a14cf30fe234ed1b12021fba996444957"><div class="ttname"><a href="classripple_1_1JobQueue.html#a14cf30fe234ed1b12021fba996444957">ripple::JobQueue::getJobLimit</a></div><div class="ttdeci">int getJobLimit(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00415">JobQueue.cpp:415</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a14cf30fe234ed1b12021fba996444957"><div class="ttname"><a href="classripple_1_1JobQueue.html#a14cf30fe234ed1b12021fba996444957">ripple::JobQueue::getJobLimit</a></div><div class="ttdeci">int getJobLimit(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00404">JobQueue.cpp:404</a></div></div>
<div class="ttc" id="aduration_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_af413c96bdf42fee7e7edd2d98e690611"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#af413c96bdf42fee7e7edd2d98e690611">ripple::JobQueue::Coro::coro_</a></div><div class="ttdeci">boost::coroutines::asymmetric_coroutine&lt; void &gt;::pull_type coro_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00070">JobQueue.h:70</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a764e7597e4d15e282f3d87d1364c577f"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a764e7597e4d15e282f3d87d1364c577f">ripple::JobQueue::Coro::expectEarlyExit</a></div><div class="ttdeci">void expectEarlyExit()</div><div class="ttdoc">Once called, the Coro allows early exit without an assert.</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a8a0f5f0f114ceb9d5f03f66252d6889b"><div class="ttname"><a href="classripple_1_1JobQueue.html#a8a0f5f0f114ceb9d5f03f66252d6889b">ripple::JobQueue::getJson</a></div><div class="ttdeci">Json::Value getJson(int c=0)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00179">JobQueue.cpp:179</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_1JobQueue_html_a8a0f5f0f114ceb9d5f03f66252d6889b"><div class="ttname"><a href="classripple_1_1JobQueue.html#a8a0f5f0f114ceb9d5f03f66252d6889b">ripple::JobQueue::getJson</a></div><div class="ttdeci">Json::Value getJson(int c=0)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00196">JobQueue.cpp:196</a></div></div>
<div class="ttc" id="aclassripple_1_1perf_1_1PerfLog_html"><div class="ttname"><a href="classripple_1_1perf_1_1PerfLog.html">ripple::perf::PerfLog</a></div><div class="ttdoc">Singleton class that maintains performance counters and optionally writes Json-formatted data to a di...</div><div class="ttdef"><b>Definition:</b> <a href="PerfLog_8h_source.html#l00048">PerfLog.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aa5498338b13efc92f47517a44990b6ff"><div class="ttname"><a href="classripple_1_1JobQueue.html#aa5498338b13efc92f47517a44990b6ff">ripple::JobQueue::addRefCountedJob</a></div><div class="ttdeci">bool addRefCountedJob(JobType type, std::string const &amp;name, JobFunction const &amp;func)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00079">JobQueue.cpp:79</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aa5498338b13efc92f47517a44990b6ff"><div class="ttname"><a href="classripple_1_1JobQueue.html#aa5498338b13efc92f47517a44990b6ff">ripple::JobQueue::addRefCountedJob</a></div><div class="ttdeci">bool addRefCountedJob(JobType type, std::string const &amp;name, JobFunction const &amp;func)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00078">JobQueue.cpp:78</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_af5e34187d55aa58e551dc196aaf1ec25"><div class="ttname"><a href="classripple_1_1JobQueue.html#af5e34187d55aa58e551dc196aaf1ec25">ripple::JobQueue::addJob</a></div><div class="ttdeci">bool addJob(JobType type, std::string const &amp;name, JobHandler &amp;&amp;jobHandler)</div><div class="ttdoc">Adds a job to the JobQueue.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00166">JobQueue.h:166</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="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function&lt; void()&gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_ac09ae854553dc54ac8b5be6cf3e9bd7d"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#ac09ae854553dc54ac8b5be6cf3e9bd7d">ripple::JobQueue::Coro::jq_</a></div><div class="ttdeci">JobQueue &amp; jq_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00063">JobQueue.h:63</a></div></div>
<div class="ttc" id="astructripple_1_1Workers_1_1Callback_html"><div class="ttname"><a href="structripple_1_1Workers_1_1Callback.html">ripple::Workers::Callback</a></div><div class="ttdoc">Called to perform tasks as needed.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8h_source.html#l00072">Workers.h:72</a></div></div>
<div class="ttc" id="astructripple_1_1Workers_1_1Callback_html"><div class="ttname"><a href="structripple_1_1Workers_1_1Callback.html">ripple::Workers::Callback</a></div><div class="ttdoc">Called to perform tasks as needed.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8h_source.html#l00083">Workers.h:83</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ac4a8f09545229c70f800d22bdda69026"><div class="ttname"><a href="classripple_1_1JobQueue.html#ac4a8f09545229c70f800d22bdda69026">ripple::JobQueue::m_journal</a></div><div class="ttdeci">beast::Journal m_journal</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00245">JobQueue.h:245</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html">ripple::JobQueue::Coro</a></div><div class="ttdoc">Coroutines must run to completion.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00059">JobQueue.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a9a41016e2a2a968e0da664237078273a"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a9a41016e2a2a968e0da664237078273a">ripple::JobQueue::Coro::~Coro</a></div><div class="ttdeci">~Coro()</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ab9dfcd27fee120a72875872a68f12ffb"><div class="ttname"><a href="classripple_1_1JobQueue.html#ab9dfcd27fee120a72875872a68f12ffb">ripple::JobQueue::getJobCount</a></div><div class="ttdeci">int getJobCount(JobType t) const</div><div class="ttdoc">Jobs waiting at this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00111">JobQueue.cpp:111</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ab9dfcd27fee120a72875872a68f12ffb"><div class="ttname"><a href="classripple_1_1JobQueue.html#ab9dfcd27fee120a72875872a68f12ffb">ripple::JobQueue::getJobCount</a></div><div class="ttdeci">int getJobCount(JobType t) const</div><div class="ttdoc">Jobs waiting at this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00128">JobQueue.cpp:128</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a49eb1410e6f9ba39619c1dfb41774f8b"><div class="ttname"><a href="classripple_1_1JobQueue.html#a49eb1410e6f9ba39619c1dfb41774f8b">ripple::JobQueue::jobCounter_</a></div><div class="ttdeci">JobCounter jobCounter_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00249">JobQueue.h:249</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a0d17427a14e0f92688f306152ee6c221"><div class="ttname"><a href="classripple_1_1JobQueue.html#a0d17427a14e0f92688f306152ee6c221">ripple::JobQueue::m_invalidJobData</a></div><div class="ttdeci">JobTypeData m_invalidJobData</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00253">JobQueue.h:253</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a50fd656928f49cd10d590f27329f2990"><div class="ttname"><a href="classripple_1_1JobQueue.html#a50fd656928f49cd10d590f27329f2990">ripple::JobQueue::getJobCountTotal</a></div><div class="ttdeci">int getJobCountTotal(JobType t) const</div><div class="ttdoc">Jobs waiting plus running at this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00121">JobQueue.cpp:121</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a50fd656928f49cd10d590f27329f2990"><div class="ttname"><a href="classripple_1_1JobQueue.html#a50fd656928f49cd10d590f27329f2990">ripple::JobQueue::getJobCountTotal</a></div><div class="ttdeci">int getJobCountTotal(JobType t) const</div><div class="ttdoc">Jobs waiting plus running at this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00138">JobQueue.cpp:138</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a2f2b97204a563d708fcd3ee4262db824"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a2f2b97204a563d708fcd3ee4262db824">ripple::JobQueue::Coro::resume</a></div><div class="ttdeci">void resume()</div><div class="ttdoc">Resume coroutine execution.</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a9ae6d29e6af4311658bf567baed62561"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a9ae6d29e6af4311658bf567baed62561">ripple::JobQueue::Coro::lvs_</a></div><div class="ttdeci">detail::LocalValues lvs_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00062">JobQueue.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_abf8b35538eae5b48a7c55e8676569fce"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#abf8b35538eae5b48a7c55e8676569fce">ripple::JobQueue::Coro::Coro</a></div><div class="ttdeci">Coro(Coro_create_t, JobQueue &amp;, JobType, std::string const &amp;, F &amp;&amp;)</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a5823c4740d0e0943cb7ba722154d0350"><div class="ttname"><a href="classripple_1_1JobQueue.html#a5823c4740d0e0943cb7ba722154d0350">ripple::JobQueue::~JobQueue</a></div><div class="ttdeci">~JobQueue()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00065">JobQueue.cpp:65</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ac25021cf0852da2b3993654b243a6fc1"><div class="ttname"><a href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1">ripple::JobQueue::hook</a></div><div class="ttdeci">beast::insight::Hook hook</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00268">JobQueue.h:268</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a5823c4740d0e0943cb7ba722154d0350"><div class="ttname"><a href="classripple_1_1JobQueue.html#a5823c4740d0e0943cb7ba722154d0350">ripple::JobQueue::~JobQueue</a></div><div class="ttdeci">~JobQueue()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00064">JobQueue.cpp:64</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ac25021cf0852da2b3993654b243a6fc1"><div class="ttname"><a href="classripple_1_1JobQueue.html#ac25021cf0852da2b3993654b243a6fc1">ripple::JobQueue::hook</a></div><div class="ttdeci">beast::insight::Hook hook</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00267">JobQueue.h:267</a></div></div>
<div class="ttc" id="aenable_if_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a35cc379df37dd5e5b2ac28bfda99aa4c"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a35cc379df37dd5e5b2ac28bfda99aa4c">ripple::JobQueue::Coro::cv_</a></div><div class="ttdeci">std::condition_variable cv_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00069">JobQueue.h:69</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_acae91f15721850745d3e208c0378a00d"><div class="ttname"><a href="classripple_1_1JobQueue.html#acae91f15721850745d3e208c0378a00d">ripple::JobQueue::m_mutex</a></div><div class="ttdeci">std::mutex m_mutex</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00246">JobQueue.h:246</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a8f38dc86d76f91ac5b820e24fbdb7a50"><div class="ttname"><a href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50">ripple::JobQueue::m_collector</a></div><div class="ttdeci">beast::insight::Collector::ptr m_collector</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00266">JobQueue.h:266</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a57da3c9eea6d32bf5232ec0c27e600ed"><div class="ttname"><a href="classripple_1_1JobQueue.html#a57da3c9eea6d32bf5232ec0c27e600ed">ripple::JobQueue::isOverloaded</a></div><div class="ttdeci">bool isOverloaded()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00171">JobQueue.cpp:171</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a8f38dc86d76f91ac5b820e24fbdb7a50"><div class="ttname"><a href="classripple_1_1JobQueue.html#a8f38dc86d76f91ac5b820e24fbdb7a50">ripple::JobQueue::m_collector</a></div><div class="ttdeci">beast::insight::Collector::ptr m_collector</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00265">JobQueue.h:265</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a57da3c9eea6d32bf5232ec0c27e600ed"><div class="ttname"><a href="classripple_1_1JobQueue.html#a57da3c9eea6d32bf5232ec0c27e600ed">ripple::JobQueue::isOverloaded</a></div><div class="ttdeci">bool isOverloaded()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00188">JobQueue.cpp:188</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a4fc7922733e3fc99efdc8c93a29759b0"><div class="ttname"><a href="classripple_1_1JobQueue.html#a4fc7922733e3fc99efdc8c93a29759b0">ripple::JobQueue::isStopping</a></div><div class="ttdeci">bool isStopping() const</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00230">JobQueue.h:230</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ace46ddb99e1da2748bc42a4243c5a187"><div class="ttname"><a href="classripple_1_1JobQueue.html#ace46ddb99e1da2748bc42a4243c5a187">ripple::JobQueue::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="JobQueue_8cpp_source.html#l00362">JobQueue.cpp:362</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ace46ddb99e1da2748bc42a4243c5a187"><div class="ttname"><a href="classripple_1_1JobQueue.html#ace46ddb99e1da2748bc42a4243c5a187">ripple::JobQueue::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="JobQueue_8cpp_source.html#l00351">JobQueue.cpp:351</a></div></div>
<div class="ttc" id="aenable_shared_from_this_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a44229c25e3074a4d76e4e8306ea1b1e8"><div class="ttname"><a href="classripple_1_1JobQueue.html#a44229c25e3074a4d76e4e8306ea1b1e8">ripple::JobQueue::m_jobData</a></div><div class="ttdeci">JobDataMap m_jobData</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00252">JobQueue.h:252</a></div></div>
<div class="ttc" id="astructripple_1_1JobTypeData_html"><div class="ttname"><a href="structripple_1_1JobTypeData.html">ripple::JobTypeData</a></div><div class="ttdef"><b>Definition:</b> <a href="JobTypeData_8h_source.html#l00029">JobTypeData.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1Job_html"><div class="ttname"><a href="classripple_1_1Job.html">ripple::Job</a></div><div class="ttdef"><b>Definition:</b> <a href="Job_8h_source.html#l00094">Job.h:94</a></div></div>
<div class="ttc" id="aclassripple_1_1ClosureCounter_html"><div class="ttname"><a href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter&lt; void, Job &amp; &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1ClosureCounter_html"><div class="ttname"><a href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter&lt; void &gt;</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition:</b> <a href="Journal_8h_source.html#l00058">Journal.h:58</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a64c1e56256e2e60a5a0b2d0c32dc3a75"><div class="ttname"><a href="classripple_1_1JobQueue.html#a64c1e56256e2e60a5a0b2d0c32dc3a75">ripple::JobQueue::getJobTypeData</a></div><div class="ttdeci">JobTypeData &amp; getJobTypeData(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00244">JobQueue.cpp:244</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a64c1e56256e2e60a5a0b2d0c32dc3a75"><div class="ttname"><a href="classripple_1_1JobQueue.html#a64c1e56256e2e60a5a0b2d0c32dc3a75">ripple::JobQueue::getJobTypeData</a></div><div class="ttdeci">JobTypeData &amp; getJobTypeData(JobType type)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00261">JobQueue.cpp:261</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a36d1dcfece4b544e0b584ef11d78bd4c"><div class="ttname"><a href="classripple_1_1JobQueue.html#a36d1dcfece4b544e0b584ef11d78bd4c">ripple::JobQueue::m_lastJob</a></div><div class="ttdeci">std::uint64_t m_lastJob</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00247">JobQueue.h:247</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a540fcd3211d86c0194bf5c154ab98541"><div class="ttname"><a href="classripple_1_1JobQueue.html#a540fcd3211d86c0194bf5c154ab98541">ripple::JobQueue::isStopped</a></div><div class="ttdeci">bool isStopped() const</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00280">JobQueue.cpp:280</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a540fcd3211d86c0194bf5c154ab98541"><div class="ttname"><a href="classripple_1_1JobQueue.html#a540fcd3211d86c0194bf5c154ab98541">ripple::JobQueue::isStopped</a></div><div class="ttdeci">bool isStopped() const</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00297">JobQueue.cpp:297</a></div></div>
<div class="ttc" id="aatomic_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic_bool</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_adf59dc12d67b8e0d9dc82e8023e9de97"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#adf59dc12d67b8e0d9dc82e8023e9de97">ripple::JobQueue::Coro::yield</a></div><div class="ttdeci">void yield() const</div><div class="ttdoc">Suspend coroutine execution.</div></div>
<div class="ttc" id="amap_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/map.html">std::map&lt; JobType, JobTypeData &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ad35cfdcd3057ca05d9109227bfbedeb5"><div class="ttname"><a href="classripple_1_1JobQueue.html#ad35cfdcd3057ca05d9109227bfbedeb5">ripple::JobQueue::stopping_</a></div><div class="ttdeci">std::atomic_bool stopping_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00250">JobQueue.h:250</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a29510ba2ca7fb594aea5778bc661960f"><div class="ttname"><a href="classripple_1_1JobQueue.html#a29510ba2ca7fb594aea5778bc661960f">ripple::JobQueue::stopped_</a></div><div class="ttdeci">std::atomic_bool stopped_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00251">JobQueue.h:251</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a44de9dcc90ce0aa43b00172f22340c23"><div class="ttname"><a href="classripple_1_1JobQueue.html#a44de9dcc90ce0aa43b00172f22340c23">ripple::JobQueue::rendezvous</a></div><div class="ttdeci">void rendezvous()</div><div class="ttdoc">Block until no jobs running.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00237">JobQueue.cpp:237</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a44de9dcc90ce0aa43b00172f22340c23"><div class="ttname"><a href="classripple_1_1JobQueue.html#a44de9dcc90ce0aa43b00172f22340c23">ripple::JobQueue::rendezvous</a></div><div class="ttdeci">void rendezvous()</div><div class="ttdoc">Block until no jobs running.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00254">JobQueue.cpp:254</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a035344c995eb7c257f15cf844a2bf913"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a035344c995eb7c257f15cf844a2bf913">ripple::JobQueue::Coro::join</a></div><div class="ttdeci">void join()</div><div class="ttdoc">Waits until coroutine returns from the user function.</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a4adb1c6eb251bde0b9e56b082ef2ea68"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a4adb1c6eb251bde0b9e56b082ef2ea68">ripple::JobQueue::Coro::type_</a></div><div class="ttdeci">JobType type_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00064">JobQueue.h:64</a></div></div>
<div class="ttc" id="aclassripple_1_1Workers_html"><div class="ttname"><a href="classripple_1_1Workers.html">ripple::Workers</a></div><div class="ttdoc">Workers is effectively a thread pool.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8h_source.html#l00068">Workers.h:68</a></div></div>
<div class="ttc" id="aclassripple_1_1Workers_html"><div class="ttname"><a href="classripple_1_1Workers.html">ripple::Workers</a></div><div class="ttdoc">Workers is effectively a thread pool.</div><div class="ttdef"><b>Definition:</b> <a href="Workers_8h_source.html#l00079">Workers.h:79</a></div></div>
<div class="ttc" id="aclassbeast_1_1insight_1_1Gauge_html"><div class="ttname"><a href="classbeast_1_1insight_1_1Gauge.html">beast::insight::Gauge</a></div><div class="ttdoc">A metric for measuring an integral value.</div><div class="ttdef"><b>Definition:</b> <a href="Gauge_8h_source.html#l00039">Gauge.h:39</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a9745e6fb4f8b6838e8dba71024232882"><div class="ttname"><a href="classripple_1_1JobQueue.html#a9745e6fb4f8b6838e8dba71024232882">ripple::JobQueue::m_cancelCallback</a></div><div class="ttdeci">Job::CancelCallback m_cancelCallback</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00262">JobQueue.h:262</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html"><div class="ttname"><a href="classripple_1_1JobQueue.html">ripple::JobQueue</a></div><div class="ttdoc">A pool of threads to perform work.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00055">JobQueue.h:55</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_af6173de25e00f0eb35fd6adbc903ab08"><div class="ttname"><a href="classripple_1_1JobQueue.html#af6173de25e00f0eb35fd6adbc903ab08">ripple::JobQueue::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00258">JobQueue.cpp:258</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a685aca6c37cce283d45467ce5c918806"><div class="ttname"><a href="classripple_1_1JobQueue.html#a685aca6c37cce283d45467ce5c918806">ripple::JobQueue::getJobCountGE</a></div><div class="ttdeci">int getJobCountGE(JobType t) const</div><div class="ttdoc">All waiting jobs at or greater than this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00131">JobQueue.cpp:131</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_af6173de25e00f0eb35fd6adbc903ab08"><div class="ttname"><a href="classripple_1_1JobQueue.html#af6173de25e00f0eb35fd6adbc903ab08">ripple::JobQueue::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00275">JobQueue.cpp:275</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a685aca6c37cce283d45467ce5c918806"><div class="ttname"><a href="classripple_1_1JobQueue.html#a685aca6c37cce283d45467ce5c918806">ripple::JobQueue::getJobCountGE</a></div><div class="ttdeci">int getJobCountGE(JobType t) const</div><div class="ttdoc">All waiting jobs at or greater than this priority.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00148">JobQueue.cpp:148</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a1b85222d497232aadaf559913d3ec475"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a1b85222d497232aadaf559913d3ec475">ripple::JobQueue::Coro::name_</a></div><div class="ttdeci">std::string name_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00065">JobQueue.h:65</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_1JobQueue_1_1Coro_html_ac956633e9ba5a1ae42a3d14a575ff674"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#ac956633e9ba5a1ae42a3d14a575ff674">ripple::JobQueue::Coro::yield_</a></div><div class="ttdeci">boost::coroutines::asymmetric_coroutine&lt; void &gt;::push_type * yield_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00071">JobQueue.h:71</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_abbe39ec5295b5704fc44414936f0d31b"><div class="ttname"><a href="classripple_1_1JobQueue.html#abbe39ec5295b5704fc44414936f0d31b">ripple::JobQueue::queueJob</a></div><div class="ttdeci">void queueJob(Job const &amp;job, std::lock_guard&lt; std::mutex &gt; const &amp;lock)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00286">JobQueue.cpp:286</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a5ccb8c2d7e7c8bfe6ba67ab538cdfba0"><div class="ttname"><a href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0">ripple::JobQueue::perfLog_</a></div><div class="ttdeci">perf::PerfLog &amp; perfLog_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00265">JobQueue.h:265</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a5ccb8c2d7e7c8bfe6ba67ab538cdfba0"><div class="ttname"><a href="classripple_1_1JobQueue.html#a5ccb8c2d7e7c8bfe6ba67ab538cdfba0">ripple::JobQueue::perfLog_</a></div><div class="ttdeci">perf::PerfLog &amp; perfLog_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00264">JobQueue.h:264</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a5573d1100550035d43a54b1610a205c7"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a5573d1100550035d43a54b1610a205c7">ripple::JobQueue::Coro::finished_</a></div><div class="ttdeci">bool finished_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00073">JobQueue.h:73</a></div></div>
<div class="ttc" id="acondition_variable_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a></div></div>
<div class="ttc" id="astructripple_1_1Coro__create__t_html"><div class="ttname"><a href="structripple_1_1Coro__create__t.html">ripple::Coro_create_t</a></div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00040">JobQueue.h:40</a></div></div>
<div class="ttc" id="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="anamespaceripple_html_ae0f54f8ce649d639bf3e2b295347e17a"><div class="ttname"><a href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">ripple::JobType</a></div><div class="ttdeci">JobType</div><div class="ttdef"><b>Definition:</b> <a href="Job_8h_source.html#l00034">Job.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ace2ad391ff9228fbb0b4914b7541e8a4"><div class="ttname"><a href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4">ripple::JobQueue::job_count</a></div><div class="ttdeci">beast::insight::Gauge job_count</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00267">JobQueue.h:267</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ace2ad391ff9228fbb0b4914b7541e8a4"><div class="ttname"><a href="classripple_1_1JobQueue.html#ace2ad391ff9228fbb0b4914b7541e8a4">ripple::JobQueue::job_count</a></div><div class="ttdeci">beast::insight::Gauge job_count</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00266">JobQueue.h:266</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a1f7febd6ceef544a109ea398b5453e51"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a1f7febd6ceef544a109ea398b5453e51">ripple::JobQueue::Coro::mutex_run_</a></div><div class="ttdeci">std::mutex mutex_run_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00068">JobQueue.h:68</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a8dd2b8ab272921eaa7d7cd8f4a5fc3e9"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a8dd2b8ab272921eaa7d7cd8f4a5fc3e9">ripple::JobQueue::Coro::mutex_</a></div><div class="ttdeci">std::mutex mutex_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00067">JobQueue.h:67</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_ad1a59858d7bdd5113e0afade3e0c24c4"><div class="ttname"><a href="classripple_1_1JobQueue.html#ad1a59858d7bdd5113e0afade3e0c24c4">ripple::JobQueue::m_processCount</a></div><div class="ttdeci">int m_processCount</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00256">JobQueue.h:256</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_af2bac41337df843e48f313b178e973ad"><div class="ttname"><a href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad">ripple::JobQueue::cv_</a></div><div class="ttdeci">std::condition_variable cv_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00270">JobQueue.h:270</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aaacda2b13f6602a6db919fdc2a8bcdec"><div class="ttname"><a href="classripple_1_1JobQueue.html#aaacda2b13f6602a6db919fdc2a8bcdec">ripple::JobQueue::makeLoadEvent</a></div><div class="ttdeci">std::unique_ptr&lt; LoadEvent &gt; makeLoadEvent(JobType t, std::string const &amp;name)</div><div class="ttdoc">Return a scoped LoadEvent.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00148">JobQueue.cpp:148</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_af2bac41337df843e48f313b178e973ad"><div class="ttname"><a href="classripple_1_1JobQueue.html#af2bac41337df843e48f313b178e973ad">ripple::JobQueue::cv_</a></div><div class="ttdeci">std::condition_variable cv_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00269">JobQueue.h:269</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aaacda2b13f6602a6db919fdc2a8bcdec"><div class="ttname"><a href="classripple_1_1JobQueue.html#aaacda2b13f6602a6db919fdc2a8bcdec">ripple::JobQueue::makeLoadEvent</a></div><div class="ttdeci">std::unique_ptr&lt; LoadEvent &gt; makeLoadEvent(JobType t, std::string const &amp;name)</div><div class="ttdoc">Return a scoped LoadEvent.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00165">JobQueue.cpp:165</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a60010e2872164e7be427470efb0797e0"><div class="ttname"><a href="classripple_1_1JobQueue.html#a60010e2872164e7be427470efb0797e0">ripple::JobQueue::m_workers</a></div><div class="ttdeci">Workers m_workers</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00261">JobQueue.h:261</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a719a330a06633559303d6ebcd5945b07"><div class="ttname"><a href="classripple_1_1JobQueue.html#a719a330a06633559303d6ebcd5945b07">ripple::JobQueue::addLoadEvents</a></div><div class="ttdeci">void addLoadEvents(JobType t, int count, std::chrono::milliseconds elapsed)</div><div class="ttdoc">Add multiple load events.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00160">JobQueue.cpp:160</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a719a330a06633559303d6ebcd5945b07"><div class="ttname"><a href="classripple_1_1JobQueue.html#a719a330a06633559303d6ebcd5945b07">ripple::JobQueue::addLoadEvents</a></div><div class="ttdeci">void addLoadEvents(JobType t, int count, std::chrono::milliseconds elapsed)</div><div class="ttdoc">Add multiple load events.</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00177">JobQueue.cpp:177</a></div></div>
<div class="ttc" id="astructripple_1_1detail_1_1LocalValues_html"><div class="ttname"><a href="structripple_1_1detail_1_1LocalValues.html">ripple::detail::LocalValues</a></div><div class="ttdef"><b>Definition:</b> <a href="LocalValue_8h_source.html#l00031">LocalValue.h:31</a></div></div>
<div class="ttc" id="aunique_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassbeast_1_1insight_1_1Hook_html"><div class="ttname"><a href="classbeast_1_1insight_1_1Hook.html">beast::insight::Hook</a></div><div class="ttdoc">A reference to a handler for performing polled collection.</div><div class="ttdef"><b>Definition:</b> <a href="Hook_8h_source.html#l00031">Hook.h:31</a></div></div>
<div class="ttc" id="aset_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/set.html">std::set</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aea4a8725f6acf0a4840679526754c469"><div class="ttname"><a href="classripple_1_1JobQueue.html#aea4a8725f6acf0a4840679526754c469">ripple::JobQueue::getNextJob</a></div><div class="ttdeci">void getNextJob(Job &amp;job)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00309">JobQueue.cpp:309</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_aea4a8725f6acf0a4840679526754c469"><div class="ttname"><a href="classripple_1_1JobQueue.html#aea4a8725f6acf0a4840679526754c469">ripple::JobQueue::getNextJob</a></div><div class="ttdeci">void getNextJob(Job &amp;job)</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00303">JobQueue.cpp:303</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition:</b> <a href="json__value_8h_source.html#l00145">json_value.h:145</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a5b4f09204dac581597813c60cecb2afe"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a5b4f09204dac581597813c60cecb2afe">ripple::JobQueue::Coro::operator=</a></div><div class="ttdeci">Coro &amp; operator=(Coro const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a372851e769e2daac2f6c1e704be79567"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a372851e769e2daac2f6c1e704be79567">ripple::JobQueue::Coro::running_</a></div><div class="ttdeci">bool running_</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8h_source.html#l00066">JobQueue.h:66</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a82df9d9e8400ad01e46cdab9c4da3cf7"><div class="ttname"><a href="classripple_1_1JobQueue.html#a82df9d9e8400ad01e46cdab9c4da3cf7">ripple::JobQueue::collect</a></div><div class="ttdeci">void collect()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00072">JobQueue.cpp:72</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html_a82df9d9e8400ad01e46cdab9c4da3cf7"><div class="ttname"><a href="classripple_1_1JobQueue.html#a82df9d9e8400ad01e46cdab9c4da3cf7">ripple::JobQueue::collect</a></div><div class="ttdeci">void collect()</div><div class="ttdef"><b>Definition:</b> <a href="JobQueue_8cpp_source.html#l00071">JobQueue.cpp:71</a></div></div>
<div class="ttc" id="aclassripple_1_1JobQueue_1_1Coro_html_a7b420fe0e3eacc79ee483debccbff40a"><div class="ttname"><a href="classripple_1_1JobQueue_1_1Coro.html#a7b420fe0e3eacc79ee483debccbff40a">ripple::JobQueue::Coro::runnable</a></div><div class="ttdeci">bool runnable() const</div><div class="ttdoc">Returns true if the Coro is still runnable (has not returned).</div></div>
<div class="ttc" id="aclassripple_1_1ClosureCounter_html_a5c4e424f66edeb721a59fd151fed604e"><div class="ttname"><a href="classripple_1_1ClosureCounter.html#a5c4e424f66edeb721a59fd151fed604e">ripple::ClosureCounter::wrap</a></div><div class="ttdeci">std::optional&lt; Substitute&lt; Closure &gt; &gt; wrap(Closure &amp;&amp;closure)</div><div class="ttdoc">Wrap the passed closure with a reference counter.</div><div class="ttdef"><b>Definition:</b> <a href="ClosureCounter_8h_source.html#l00192">ClosureCounter.h:192</a></div></div>
<!-- start footer part -->