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

332 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 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::TxQ::Metrics Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1TxQ.html">TxQ</a></li><li class="navelem"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html">Metrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1TxQ_1_1Metrics-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::TxQ::Metrics Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Structure returned by <a class="el" href="classripple_1_1TxQ.html#a2a08d6cdb1e6700a24dc0f71eb3ef7ed">TxQ::getMetrics</a>, expressed in reference fee level units.
<a href="structripple_1_1TxQ_1_1Metrics.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="TxQ_8h_source.html">TxQ.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::TxQ::Metrics:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1TxQ_1_1Metrics__coll__graph.png" border="0" usemap="#aripple_1_1TxQ_1_1Metrics_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1TxQ_1_1Metrics_coll__map" id="aripple_1_1TxQ_1_1Metrics_coll__map">
<area shape="rect" title="Structure returned by TxQ::getMetrics, expressed in reference fee level units." alt="" coords="623,111,772,136"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="296,53,384,79"/>
<area shape="poly" title=" " alt="" coords="398,71,599,101,637,108,636,113,598,106,397,76"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="271,103,409,143"/>
<area shape="poly" title=" " alt="" coords="423,121,622,121,622,126,423,126"/>
<area shape="rect" href="classripple_1_1unit_1_1ValueUnit.html" title=" " alt="" coords="259,193,421,233"/>
<area shape="poly" title=" " alt="" coords="435,212,516,204,558,196,598,185,644,161,680,134,683,138,647,165,600,190,559,202,517,210,436,217"/>
<area shape="rect" title=" " alt="" coords="15,5,199,60"/>
<area shape="poly" title=" " alt="" coords="205,66,211,71,229,91,238,112,246,132,261,154,282,174,306,190,303,195,279,178,257,157,241,134,233,114,224,94,207,75,201,70"/>
<area shape="rect" title=" " alt="" coords="9,85,206,125"/>
<area shape="poly" title=" " alt="" coords="192,127,210,134,264,162,310,190,307,195,262,167,208,139,190,132"/>
<area shape="rect" title=" " alt="" coords="6,149,209,204"/>
<area shape="poly" title=" " alt="" coords="223,192,259,197,258,203,222,197"/>
<area shape="rect" title=" " alt="" coords="5,229,209,269"/>
<area shape="poly" title=" " alt="" coords="223,228,258,223,259,228,223,233"/>
<area shape="rect" title=" " alt="" coords="7,293,208,333"/>
<area shape="poly" title=" " alt="" coords="189,286,208,278,303,230,306,235,210,283,191,291"/>
<area shape="rect" title=" " alt="" coords="15,357,199,412"/>
<area shape="poly" title=" " alt="" coords="198,349,208,342,242,316,274,286,322,231,326,234,278,289,246,320,211,347,201,353"/>
</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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5f8431c7f8f88f9455e5dce38defa925" id="r_a5f8431c7f8f88f9455e5dce38defa925"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a5f8431c7f8f88f9455e5dce38defa925">Metrics</a> ()=default</td></tr>
<tr class="memdesc:a5f8431c7f8f88f9455e5dce38defa925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a5f8431c7f8f88f9455e5dce38defa925"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ade3363912328dbd806a24207929c4fb3" id="r_ade3363912328dbd806a24207929c4fb3"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#ade3363912328dbd806a24207929c4fb3">txCount</a></td></tr>
<tr class="memdesc:ade3363912328dbd806a24207929c4fb3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Number.html">Number</a> of transactions in the queue. <br /></td></tr>
<tr class="separator:ade3363912328dbd806a24207929c4fb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61ea155db2d26ef9addb0e889775ce85" id="r_a61ea155db2d26ef9addb0e889775ce85"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a61ea155db2d26ef9addb0e889775ce85">txQMaxSize</a></td></tr>
<tr class="memdesc:a61ea155db2d26ef9addb0e889775ce85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max transactions currently allowed in queue. <br /></td></tr>
<tr class="separator:a61ea155db2d26ef9addb0e889775ce85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6d188cab1f33a838cda74a0dc6cbbf2" id="r_aa6d188cab1f33a838cda74a0dc6cbbf2"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#aa6d188cab1f33a838cda74a0dc6cbbf2">txInLedger</a></td></tr>
<tr class="memdesc:aa6d188cab1f33a838cda74a0dc6cbbf2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Number.html">Number</a> of transactions currently in the open ledger. <br /></td></tr>
<tr class="separator:aa6d188cab1f33a838cda74a0dc6cbbf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d5fc7af8dab3cda00ba533feb108f1a" id="r_a2d5fc7af8dab3cda00ba533feb108f1a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a2d5fc7af8dab3cda00ba533feb108f1a">txPerLedger</a></td></tr>
<tr class="memdesc:a2d5fc7af8dab3cda00ba533feb108f1a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Number.html">Number</a> of transactions expected per ledger. <br /></td></tr>
<tr class="separator:a2d5fc7af8dab3cda00ba533feb108f1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ef5bb734c6c198cd67ab6b9ccd9fe4e" id="r_a9ef5bb734c6c198cd67ab6b9ccd9fe4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a9ef5bb734c6c198cd67ab6b9ccd9fe4e">referenceFeeLevel</a></td></tr>
<tr class="memdesc:a9ef5bb734c6c198cd67ab6b9ccd9fe4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference transaction fee level. <br /></td></tr>
<tr class="separator:a9ef5bb734c6c198cd67ab6b9ccd9fe4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a046a7eebf075ab4c435845458cdab036" id="r_a046a7eebf075ab4c435845458cdab036"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a046a7eebf075ab4c435845458cdab036">minProcessingFeeLevel</a></td></tr>
<tr class="memdesc:a046a7eebf075ab4c435845458cdab036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum fee level for a transaction to be considered for the open ledger or the queue. <br /></td></tr>
<tr class="separator:a046a7eebf075ab4c435845458cdab036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee1c684ec90ea6e8e6beea48bcaaf8c5" id="r_aee1c684ec90ea6e8e6beea48bcaaf8c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#aee1c684ec90ea6e8e6beea48bcaaf8c5">medFeeLevel</a></td></tr>
<tr class="memdesc:aee1c684ec90ea6e8e6beea48bcaaf8c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Median fee level of the last ledger. <br /></td></tr>
<tr class="separator:aee1c684ec90ea6e8e6beea48bcaaf8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dfae7d857bda5f73e70b47d3bb46455" id="r_a0dfae7d857bda5f73e70b47d3bb46455"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1TxQ_1_1Metrics.html#a0dfae7d857bda5f73e70b47d3bb46455">openLedgerFeeLevel</a></td></tr>
<tr class="memdesc:a0dfae7d857bda5f73e70b47d3bb46455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum fee level to get into the current open ledger, bypassing the queue. <br /></td></tr>
<tr class="separator:a0dfae7d857bda5f73e70b47d3bb46455"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure returned by <a class="el" href="classripple_1_1TxQ.html#a2a08d6cdb1e6700a24dc0f71eb3ef7ed">TxQ::getMetrics</a>, expressed in reference fee level units. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00145">145</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5f8431c7f8f88f9455e5dce38defa925" name="a5f8431c7f8f88f9455e5dce38defa925"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f8431c7f8f88f9455e5dce38defa925">&#9670;&#160;</a></span>Metrics()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::TxQ::Metrics::Metrics </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ade3363912328dbd806a24207929c4fb3" name="ade3363912328dbd806a24207929c4fb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade3363912328dbd806a24207929c4fb3">&#9670;&#160;</a></span>txCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::TxQ::Metrics::txCount</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Number.html">Number</a> of transactions in the queue. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00151">151</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="a61ea155db2d26ef9addb0e889775ce85" name="a61ea155db2d26ef9addb0e889775ce85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61ea155db2d26ef9addb0e889775ce85">&#9670;&#160;</a></span>txQMaxSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&gt; ripple::TxQ::Metrics::txQMaxSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Max transactions currently allowed in queue. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00153">153</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="aa6d188cab1f33a838cda74a0dc6cbbf2" name="aa6d188cab1f33a838cda74a0dc6cbbf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6d188cab1f33a838cda74a0dc6cbbf2">&#9670;&#160;</a></span>txInLedger</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::TxQ::Metrics::txInLedger</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Number.html">Number</a> of transactions currently in the open ledger. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00155">155</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="a2d5fc7af8dab3cda00ba533feb108f1a" name="a2d5fc7af8dab3cda00ba533feb108f1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5fc7af8dab3cda00ba533feb108f1a">&#9670;&#160;</a></span>txPerLedger</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::TxQ::Metrics::txPerLedger</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Number.html">Number</a> of transactions expected per ledger. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00157">157</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="a9ef5bb734c6c198cd67ab6b9ccd9fe4e" name="a9ef5bb734c6c198cd67ab6b9ccd9fe4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ef5bb734c6c198cd67ab6b9ccd9fe4e">&#9670;&#160;</a></span>referenceFeeLevel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a> ripple::TxQ::Metrics::referenceFeeLevel</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference transaction fee level. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00159">159</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="a046a7eebf075ab4c435845458cdab036" name="a046a7eebf075ab4c435845458cdab036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a046a7eebf075ab4c435845458cdab036">&#9670;&#160;</a></span>minProcessingFeeLevel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a> ripple::TxQ::Metrics::minProcessingFeeLevel</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum fee level for a transaction to be considered for the open ledger or the queue. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00162">162</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="aee1c684ec90ea6e8e6beea48bcaaf8c5" name="aee1c684ec90ea6e8e6beea48bcaaf8c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee1c684ec90ea6e8e6beea48bcaaf8c5">&#9670;&#160;</a></span>medFeeLevel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a> ripple::TxQ::Metrics::medFeeLevel</td>
</tr>
</table>
</div><div class="memdoc">
<p>Median fee level of the last ledger. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00164">164</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
<a id="a0dfae7d857bda5f73e70b47d3bb46455" name="a0dfae7d857bda5f73e70b47d3bb46455"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dfae7d857bda5f73e70b47d3bb46455">&#9670;&#160;</a></span>openLedgerFeeLevel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#aaaf6522d07c2b836c5fd589e9ecf578c">FeeLevel64</a> ripple::TxQ::Metrics::openLedgerFeeLevel</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum fee level to get into the current open ledger, bypassing the queue. </p>
<p class="definition">Definition at line <a class="el" href="TxQ_8h_source.html#l00167">167</a> of file <a class="el" href="TxQ_8h_source.html">TxQ.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>