ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/structripple_1_1ValidationParms.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

256 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 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::ValidationParms 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="structripple_1_1ValidationParms.html">ValidationParms</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_1ValidationParms-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::ValidationParms Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Timing parameters to control validation staleness and expiration.
<a href="structripple_1_1ValidationParms.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Validations_8h_source.html">Validations.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::ValidationParms:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1ValidationParms__coll__graph.png" border="0" usemap="#aripple_1_1ValidationParms_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1ValidationParms_coll__map" id="aripple_1_1ValidationParms_coll__map">
<area shape="rect" title="Timing parameters to control validation staleness and expiration." alt="" coords="5,152,177,177"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="14,5,169,31"/>
<area shape="poly" title=" " alt="" coords="94,45,94,152,89,152,89,45"/>
</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:aaaa4e5dc1cbca651d304076f14b4d1ba" id="r_aaaa4e5dc1cbca651d304076f14b4d1ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#aaaa4e5dc1cbca651d304076f14b4d1ba">ValidationParms</a> ()=default</td></tr>
<tr class="separator:aaaa4e5dc1cbca651d304076f14b4d1ba"><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:ae59a5bbb09863491d75c2146894d2a16" id="r_ae59a5bbb09863491d75c2146894d2a16"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#ae59a5bbb09863491d75c2146894d2a16">validationCURRENT_WALL</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{5}</td></tr>
<tr class="memdesc:ae59a5bbb09863491d75c2146894d2a16"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of seconds a validation remains current after its ledger's close time. <br /></td></tr>
<tr class="separator:ae59a5bbb09863491d75c2146894d2a16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22af23c89bfbf17f855ca2f022ca284b" id="r_a22af23c89bfbf17f855ca2f022ca284b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#a22af23c89bfbf17f855ca2f022ca284b">validationCURRENT_LOCAL</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{3}</td></tr>
<tr class="memdesc:a22af23c89bfbf17f855ca2f022ca284b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration a validation remains current after first observed. <br /></td></tr>
<tr class="separator:a22af23c89bfbf17f855ca2f022ca284b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af711ddfbba2d8b96490ba6cf6fee876f" id="r_af711ddfbba2d8b96490ba6cf6fee876f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#af711ddfbba2d8b96490ba6cf6fee876f">validationCURRENT_EARLY</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{3}</td></tr>
<tr class="memdesc:af711ddfbba2d8b96490ba6cf6fee876f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration pre-close in which validations are acceptable. <br /></td></tr>
<tr class="separator:af711ddfbba2d8b96490ba6cf6fee876f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae13046ce0ee6a36a6f513abe1915197e" id="r_ae13046ce0ee6a36a6f513abe1915197e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#ae13046ce0ee6a36a6f513abe1915197e">validationSET_EXPIRES</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{10}</td></tr>
<tr class="memdesc:ae13046ce0ee6a36a6f513abe1915197e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration a set of validations for a given ledger hash remain valid. <br /></td></tr>
<tr class="separator:ae13046ce0ee6a36a6f513abe1915197e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a733e2abe7f139c396e5f8037a15c999d" id="r_a733e2abe7f139c396e5f8037a15c999d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidationParms.html#a733e2abe7f139c396e5f8037a15c999d">validationFRESHNESS</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{20}</td></tr>
<tr class="memdesc:a733e2abe7f139c396e5f8037a15c999d"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long we consider a validation fresh. <br /></td></tr>
<tr class="separator:a733e2abe7f139c396e5f8037a15c999d"><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>Timing parameters to control validation staleness and expiration. </p>
<dl class="section note"><dt>Note</dt><dd>These are protocol level parameters that should not be changed without careful consideration. They are <em>not</em> implemented as static constexpr to allow simulation code to test alternate parameter settings. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00027">27</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aaaa4e5dc1cbca651d304076f14b4d1ba" name="aaaa4e5dc1cbca651d304076f14b4d1ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaaa4e5dc1cbca651d304076f14b4d1ba">&#9670;&#160;</a></span>ValidationParms()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::ValidationParms::ValidationParms </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">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae59a5bbb09863491d75c2146894d2a16" name="ae59a5bbb09863491d75c2146894d2a16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae59a5bbb09863491d75c2146894d2a16">&#9670;&#160;</a></span>validationCURRENT_WALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::ValidationParms::validationCURRENT_WALL = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{5}</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of seconds a validation remains current after its ledger's close time. </p>
<p>This is a safety to protect against very old validations and the time it takes to adjust the close time accuracy window. </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00037">37</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="a22af23c89bfbf17f855ca2f022ca284b" name="a22af23c89bfbf17f855ca2f022ca284b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22af23c89bfbf17f855ca2f022ca284b">&#9670;&#160;</a></span>validationCURRENT_LOCAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::ValidationParms::validationCURRENT_LOCAL = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{3}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration a validation remains current after first observed. </p>
<p>The number of seconds a validation remains current after the time we first saw it. This provides faster recovery in very rare cases where the number of validations produced by the network is lower than normal </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00045">45</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="af711ddfbba2d8b96490ba6cf6fee876f" name="af711ddfbba2d8b96490ba6cf6fee876f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af711ddfbba2d8b96490ba6cf6fee876f">&#9670;&#160;</a></span>validationCURRENT_EARLY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::ValidationParms::validationCURRENT_EARLY = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{3}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration pre-close in which validations are acceptable. </p>
<p>The number of seconds before a close time that we consider a validation acceptable. This protects against extreme clock errors </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00052">52</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="ae13046ce0ee6a36a6f513abe1915197e" name="ae13046ce0ee6a36a6f513abe1915197e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae13046ce0ee6a36a6f513abe1915197e">&#9670;&#160;</a></span>validationSET_EXPIRES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::ValidationParms::validationSET_EXPIRES = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{10}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Duration a set of validations for a given ledger hash remain valid. </p>
<p>The number of seconds before a set of validations for a given ledger hash can expire. This keeps validations for recent ledgers available for a reasonable interval. </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00060">60</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="a733e2abe7f139c396e5f8037a15c999d" name="a733e2abe7f139c396e5f8037a15c999d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a733e2abe7f139c396e5f8037a15c999d">&#9670;&#160;</a></span>validationFRESHNESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::ValidationParms::validationFRESHNESS = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{20}</td>
</tr>
</table>
</div><div class="memdoc">
<p>How long we consider a validation fresh. </p>
<p>The number of seconds since a validation has been seen for it to be considered to accurately represent a live proposer's most recent validation. This value should be sufficiently higher than ledgerMAX_CONSENSUS such that validators who are waiting for laggards are not considered offline. </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00070">70</a> of file <a class="el" href="Validations_8h_source.html">Validations.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>
Reference in New Issue View Git Blame Copy Permalink