mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-27 22:45:52 +00:00
625 lines
35 KiB
HTML
625 lines
35 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::Job Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1Job.html">Job</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1Job-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::Job Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="Job_8h_source.html">Job.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::Job:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1Job__inherit__graph.png" border="0" usemap="#aripple_1_1Job_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1Job_inherit__map" id="aripple_1_1Job_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="43,93,130,119"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="5,5,168,45"/>
|
|
<area shape="poly" title=" " alt="" coords="89,59,89,93,84,93,84,59"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::Job:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1Job__coll__graph.png" border="0" usemap="#aripple_1_1Job_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1Job_coll__map" id="aripple_1_1Job_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="1420,135,1507,161"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1116,5,1279,45"/>
|
|
<area shape="poly" title=" " alt="" coords="1293,27,1346,39,1397,62,1418,78,1435,97,1458,133,1453,136,1431,100,1414,82,1395,66,1345,44,1292,33"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="293,86,395,111"/>
|
|
<area shape="poly" title=" " alt="" coords="409,91,537,84,686,80,1199,80,1265,86,1330,99,1432,133,1431,138,1329,104,1264,91,1199,85,686,85,537,89,409,97"/>
|
|
<area shape="rect" href="classripple_1_1LoadMonitor.html" title=" " alt="" coords="613,235,761,261"/>
|
|
<area shape="poly" title=" " alt="" coords="409,107,519,127,590,146,620,166,645,190,680,234,676,237,641,193,616,170,588,150,518,133,408,112"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="1114,135,1281,161"/>
|
|
<area shape="poly" title=" " alt="" coords="1295,145,1420,145,1420,151,1295,151"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1112,216,1283,256"/>
|
|
<area shape="poly" title=" " alt="" coords="1271,209,1423,158,1425,163,1273,214"/>
|
|
<area shape="rect" href="classripple_1_1LoadEvent.html" title=" " alt="" coords="872,234,1007,259"/>
|
|
<area shape="poly" title=" " alt="" coords="1020,241,1111,237,1112,242,1021,246"/>
|
|
<area shape="poly" title=" " alt="" coords="775,245,872,244,872,250,775,250"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="298,150,390,175"/>
|
|
<area shape="poly" title=" " alt="" coords="404,160,493,168,542,177,590,189,635,210,670,233,667,237,632,215,588,195,541,182,492,173,403,166"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="252,227,436,253"/>
|
|
<area shape="poly" title=" " alt="" coords="450,247,460,248,589,248,613,248,613,253,589,253,460,253,449,253"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="258,277,430,317"/>
|
|
<area shape="poly" title=" " alt="" coords="444,288,589,269,640,258,641,263,590,275,444,293"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="289,342,399,367"/>
|
|
<area shape="poly" title=" " alt="" coords="413,346,498,332,544,320,588,306,633,283,668,259,671,263,635,287,590,310,546,325,499,337,414,351"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="5,342,152,367"/>
|
|
<area shape="poly" title=" " alt="" coords="166,352,289,352,289,357,166,357"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="644,323,731,349"/>
|
|
<area shape="poly" title=" " alt="" coords="744,334,847,332,982,323,1133,302,1209,286,1282,265,1316,253,1341,240,1394,203,1447,159,1451,163,1398,207,1344,245,1318,258,1283,271,1210,291,1134,307,982,328,847,337,745,339"/>
|
|
<area shape="poly" title=" " alt="" coords="736,316,901,257,903,262,738,321"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="275,392,413,432"/>
|
|
<area shape="poly" title=" " alt="" coords="427,404,506,394,589,376,627,362,661,346,663,351,629,367,590,381,507,399,428,409"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ac6767f9553105ee2dfcc6cc34c7b5daa" id="r_ac6767f9553105ee2dfcc6cc34c7b5daa"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#ac6767f9553105ee2dfcc6cc34c7b5daa">clock_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a></td></tr>
|
|
<tr class="separator:ac6767f9553105ee2dfcc6cc34c7b5daa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a51dd106c62fbd7c1defeae50a851c436" id="r_a51dd106c62fbd7c1defeae50a851c436"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a51dd106c62fbd7c1defeae50a851c436">Job</a> ()</td></tr>
|
|
<tr class="memdesc:a51dd106c62fbd7c1defeae50a851c436"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a51dd106c62fbd7c1defeae50a851c436"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ad7f4044aeec6d0c465bfb5a34fc224" id="r_a5ad7f4044aeec6d0c465bfb5a34fc224"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a5ad7f4044aeec6d0c465bfb5a34fc224">Job</a> (<a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> index)</td></tr>
|
|
<tr class="separator:a5ad7f4044aeec6d0c465bfb5a34fc224"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae276cc405eb0fcdf2e141b94b8301753" id="r_ae276cc405eb0fcdf2e141b94b8301753"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#ae276cc405eb0fcdf2e141b94b8301753">Job</a> (<a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> type, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> index, <a class="el" href="classripple_1_1LoadMonitor.html">LoadMonitor</a> &lm, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void()> const &job)</td></tr>
|
|
<tr class="separator:ae276cc405eb0fcdf2e141b94b8301753"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed16ceadce11b29303c62582c0ecf44c" id="r_aed16ceadce11b29303c62582c0ecf44c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#aed16ceadce11b29303c62582c0ecf44c">getType</a> () const</td></tr>
|
|
<tr class="separator:aed16ceadce11b29303c62582c0ecf44c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a789f77c51f558ff1373dbef8d206dfa6" id="r_a789f77c51f558ff1373dbef8d206dfa6"><td class="memItemLeft" align="right" valign="top">clock_type::time_point const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a789f77c51f558ff1373dbef8d206dfa6">queue_time</a> () const</td></tr>
|
|
<tr class="memdesc:a789f77c51f558ff1373dbef8d206dfa6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time when the job was queued. <br /></td></tr>
|
|
<tr class="separator:a789f77c51f558ff1373dbef8d206dfa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74918b13a3f682679d60965b04e28374" id="r_a74918b13a3f682679d60965b04e28374"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a74918b13a3f682679d60965b04e28374">doJob</a> ()</td></tr>
|
|
<tr class="separator:a74918b13a3f682679d60965b04e28374"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8413fda5a1c6c257d2b5a8b549a7d9f0" id="r_a8413fda5a1c6c257d2b5a8b549a7d9f0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a8413fda5a1c6c257d2b5a8b549a7d9f0">operator<</a> (<a class="el" href="classripple_1_1Job.html">Job</a> const &j) const</td></tr>
|
|
<tr class="separator:a8413fda5a1c6c257d2b5a8b549a7d9f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a76accd733d25c4ff5434f1f34b3bfe" id="r_a3a76accd733d25c4ff5434f1f34b3bfe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a3a76accd733d25c4ff5434f1f34b3bfe">operator></a> (<a class="el" href="classripple_1_1Job.html">Job</a> const &j) const</td></tr>
|
|
<tr class="separator:a3a76accd733d25c4ff5434f1f34b3bfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46c234efe4d4d03bbee9d99e6f65da51" id="r_a46c234efe4d4d03bbee9d99e6f65da51"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a46c234efe4d4d03bbee9d99e6f65da51">operator<=</a> (<a class="el" href="classripple_1_1Job.html">Job</a> const &j) const</td></tr>
|
|
<tr class="separator:a46c234efe4d4d03bbee9d99e6f65da51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35cc72bc9a2eb9724867ac81f87613ef" id="r_a35cc72bc9a2eb9724867ac81f87613ef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a35cc72bc9a2eb9724867ac81f87613ef">operator>=</a> (<a class="el" href="classripple_1_1Job.html">Job</a> const &j) const</td></tr>
|
|
<tr class="separator:a35cc72bc9a2eb9724867ac81f87613ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae60d6cae0e97e9f17c93945feca09fb5" id="r_ae60d6cae0e97e9f17c93945feca09fb5"><td class="memItemLeft" align="right" valign="top">static auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1CountedObject.html#ae60d6cae0e97e9f17c93945feca09fb5">getCounter</a> () noexcept</td></tr>
|
|
<tr class="separator:ae60d6cae0e97e9f17c93945feca09fb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:aba9b6441ec53d750edc217c2ed81de25" id="r_aba9b6441ec53d750edc217c2ed81de25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#aba9b6441ec53d750edc217c2ed81de25">mType</a></td></tr>
|
|
<tr class="separator:aba9b6441ec53d750edc217c2ed81de25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cb078a89e99aaa369dc9c27d9b40929" id="r_a5cb078a89e99aaa369dc9c27d9b40929"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a5cb078a89e99aaa369dc9c27d9b40929">mJobIndex</a></td></tr>
|
|
<tr class="separator:a5cb078a89e99aaa369dc9c27d9b40929"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f6c51a111175bdc3dc9f8268ccbd9b9" id="r_a1f6c51a111175bdc3dc9f8268ccbd9b9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a1f6c51a111175bdc3dc9f8268ccbd9b9">mJob</a></td></tr>
|
|
<tr class="separator:a1f6c51a111175bdc3dc9f8268ccbd9b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f5d5836f9144278d4add4951605b8dc" id="r_a1f5d5836f9144278d4add4951605b8dc"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1LoadEvent.html">LoadEvent</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a1f5d5836f9144278d4add4951605b8dc">m_loadEvent</a></td></tr>
|
|
<tr class="separator:a1f5d5836f9144278d4add4951605b8dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a015e98a2158b6fcdb707983edd2082" id="r_a0a015e98a2158b6fcdb707983edd2082"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a0a015e98a2158b6fcdb707983edd2082">mName</a></td></tr>
|
|
<tr class="separator:a0a015e98a2158b6fcdb707983edd2082"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8679000b9c528e5be78847fc8b558768" id="r_a8679000b9c528e5be78847fc8b558768"><td class="memItemLeft" align="right" valign="top">clock_type::time_point </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Job.html#a8679000b9c528e5be78847fc8b558768">m_queue_time</a></td></tr>
|
|
<tr class="separator:a8679000b9c528e5be78847fc8b558768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00095">95</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ac6767f9553105ee2dfcc6cc34c7b5daa" name="ac6767f9553105ee2dfcc6cc34c7b5daa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6767f9553105ee2dfcc6cc34c7b5daa">◆ </a></span>clock_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1Job.html#ac6767f9553105ee2dfcc6cc34c7b5daa">ripple::Job::clock_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00098">98</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a51dd106c62fbd7c1defeae50a851c436" name="a51dd106c62fbd7c1defeae50a851c436"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51dd106c62fbd7c1defeae50a851c436">◆ </a></span>Job() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::Job::Job </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Allows <a class="el" href="classripple_1_1Job.html">Job</a> to be used as a container type.</p>
|
|
<p>This is used to allow things like jobMap [key] = value. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00026">26</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ad7f4044aeec6d0c465bfb5a34fc224" name="a5ad7f4044aeec6d0c465bfb5a34fc224"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ad7f4044aeec6d0c465bfb5a34fc224">◆ </a></span>Job() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::Job::Job </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> </td>
|
|
<td class="paramname"><em>index</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00030">30</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae276cc405eb0fcdf2e141b94b8301753" name="ae276cc405eb0fcdf2e141b94b8301753"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae276cc405eb0fcdf2e141b94b8301753">◆ </a></span>Job() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::Job::Job </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1LoadMonitor.html">LoadMonitor</a> & </td>
|
|
<td class="paramname"><em>lm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void()> const & </td>
|
|
<td class="paramname"><em>job</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00034">34</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aed16ceadce11b29303c62582c0ecf44c" name="aed16ceadce11b29303c62582c0ecf44c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed16ceadce11b29303c62582c0ecf44c">◆ </a></span>getType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> ripple::Job::getType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00050">50</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a789f77c51f558ff1373dbef8d206dfa6" name="a789f77c51f558ff1373dbef8d206dfa6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a789f77c51f558ff1373dbef8d206dfa6">◆ </a></span>queue_time()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Job::clock_type::time_point const & ripple::Job::queue_time </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the time when the job was queued. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00056">56</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74918b13a3f682679d60965b04e28374" name="a74918b13a3f682679d60965b04e28374"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74918b13a3f682679d60965b04e28374">◆ </a></span>doJob()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Job::doJob </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00062">62</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8413fda5a1c6c257d2b5a8b549a7d9f0" name="a8413fda5a1c6c257d2b5a8b549a7d9f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8413fda5a1c6c257d2b5a8b549a7d9f0">◆ </a></span>operator<()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Job::operator< </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Job.html">Job</a> const & </td>
|
|
<td class="paramname"><em>j</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00099">99</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a76accd733d25c4ff5434f1f34b3bfe" name="a3a76accd733d25c4ff5434f1f34b3bfe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a76accd733d25c4ff5434f1f34b3bfe">◆ </a></span>operator>()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Job::operator> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Job.html">Job</a> const & </td>
|
|
<td class="paramname"><em>j</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00076">76</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46c234efe4d4d03bbee9d99e6f65da51" name="a46c234efe4d4d03bbee9d99e6f65da51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46c234efe4d4d03bbee9d99e6f65da51">◆ </a></span>operator<=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Job::operator<= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Job.html">Job</a> const & </td>
|
|
<td class="paramname"><em>j</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00111">111</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35cc72bc9a2eb9724867ac81f87613ef" name="a35cc72bc9a2eb9724867ac81f87613ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35cc72bc9a2eb9724867ac81f87613ef">◆ </a></span>operator>=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::Job::operator>= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Job.html">Job</a> const & </td>
|
|
<td class="paramname"><em>j</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8cpp_source.html#l00088">88</a> of file <a class="el" href="Job_8cpp_source.html">Job.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae60d6cae0e97e9f17c93945feca09fb5" name="ae60d6cae0e97e9f17c93945feca09fb5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae60d6cae0e97e9f17c93945feca09fb5">◆ </a></span>getCounter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static auto & <a class="el" href="classripple_1_1CountedObject.html">ripple::CountedObject</a>< <a class="el" href="classripple_1_1Job.html">Job</a> >::getCounter </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span><span class="mlabel">noexcept</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="CountedObject_8h_source.html#l00129">129</a> of file <a class="el" href="CountedObject_8h_source.html">CountedObject.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="aba9b6441ec53d750edc217c2ed81de25" name="aba9b6441ec53d750edc217c2ed81de25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba9b6441ec53d750edc217c2ed81de25">◆ </a></span>mType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> ripple::Job::mType</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00144">144</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5cb078a89e99aaa369dc9c27d9b40929" name="a5cb078a89e99aaa369dc9c27d9b40929"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5cb078a89e99aaa369dc9c27d9b40929">◆ </a></span>mJobIndex</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::Job::mJobIndex</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00145">145</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f6c51a111175bdc3dc9f8268ccbd9b9" name="a1f6c51a111175bdc3dc9f8268ccbd9b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f6c51a111175bdc3dc9f8268ccbd9b9">◆ </a></span>mJob</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a><void()> ripple::Job::mJob</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00146">146</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f5d5836f9144278d4add4951605b8dc" name="a1f5d5836f9144278d4add4951605b8dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f5d5836f9144278d4add4951605b8dc">◆ </a></span>m_loadEvent</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1LoadEvent.html">LoadEvent</a>> ripple::Job::m_loadEvent</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00147">147</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a015e98a2158b6fcdb707983edd2082" name="a0a015e98a2158b6fcdb707983edd2082"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a015e98a2158b6fcdb707983edd2082">◆ </a></span>mName</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::Job::mName</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00148">148</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8679000b9c528e5be78847fc8b558768" name="a8679000b9c528e5be78847fc8b558768"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8679000b9c528e5be78847fc8b558768">◆ </a></span>m_queue_time</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">clock_type::time_point ripple::Job::m_queue_time</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Job_8h_source.html#l00149">149</a> of file <a class="el" href="Job_8h_source.html">Job.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|