ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/classripple_1_1SeqEnforcer.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

275 lines
13 KiB
HTML
Raw 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::SeqEnforcer&lt; Seq &gt; Class Template 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.5 -->
<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_1SeqEnforcer.html">SeqEnforcer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1SeqEnforcer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::SeqEnforcer&lt; Seq &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Enforce validation increasing sequence requirement.
<a href="classripple_1_1SeqEnforcer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Validations_8h_source.html">Validations.h</a>&gt;</code></p>
<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:a8e1e3ece81c02b8c7e59f42caeaf4e88"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SeqEnforcer.html#a8e1e3ece81c02b8c7e59f42caeaf4e88">operator()</a> (<a class="el" href="classripple_1_1SeqEnforcer.html#ab7b09c947a59e82422879e793f0cf14e">time_point</a> now, Seq s, <a class="el" href="structripple_1_1ValidationParms.html">ValidationParms</a> const &amp;p)</td></tr>
<tr class="memdesc:a8e1e3ece81c02b8c7e59f42caeaf4e88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try advancing the largest observed validation ledger sequence. <a href="classripple_1_1SeqEnforcer.html#a8e1e3ece81c02b8c7e59f42caeaf4e88">More...</a><br /></td></tr>
<tr class="separator:a8e1e3ece81c02b8c7e59f42caeaf4e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0028fb17fa1d035b986b9edf4cd59776"><td class="memItemLeft" align="right" valign="top">Seq&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SeqEnforcer.html#a0028fb17fa1d035b986b9edf4cd59776">largest</a> () const</td></tr>
<tr class="separator:a0028fb17fa1d035b986b9edf4cd59776"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ab7b09c947a59e82422879e793f0cf14e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SeqEnforcer.html#ab7b09c947a59e82422879e793f0cf14e">time_point</a> = std::chrono::steady_clock::time_point</td></tr>
<tr class="separator:ab7b09c947a59e82422879e793f0cf14e"><td class="memSeparator" colspan="2">&#160;</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:a01e9f27df73544b7d44c634cd61541be"><td class="memItemLeft" align="right" valign="top">Seq&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SeqEnforcer.html#a01e9f27df73544b7d44c634cd61541be">seq_</a> {0}</td></tr>
<tr class="separator:a01e9f27df73544b7d44c634cd61541be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff5b1f37122ea7cd83dd2d4c9db21bc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SeqEnforcer.html#ab7b09c947a59e82422879e793f0cf14e">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SeqEnforcer.html#aff5b1f37122ea7cd83dd2d4c9db21bc2">when_</a></td></tr>
<tr class="separator:aff5b1f37122ea7cd83dd2d4c9db21bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Seq&gt;<br />
class ripple::SeqEnforcer&lt; Seq &gt;</div><p >Enforce validation increasing sequence requirement. </p>
<p >Helper class for enforcing that a validation must be larger than all unexpired validation sequence numbers previously issued by the validator tracked by the instance of this class. </p>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00098">98</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab7b09c947a59e82422879e793f0cf14e" name="ab7b09c947a59e82422879e793f0cf14e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7b09c947a59e82422879e793f0cf14e">&#9670;&#160;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1SeqEnforcer.html">ripple::SeqEnforcer</a>&lt; Seq &gt;::time_point = std::chrono::steady_clock::time_point</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="Validations_8h_source.html#l00100">100</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8e1e3ece81c02b8c7e59f42caeaf4e88" name="a8e1e3ece81c02b8c7e59f42caeaf4e88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e1e3ece81c02b8c7e59f42caeaf4e88">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1SeqEnforcer.html">ripple::SeqEnforcer</a>&lt; Seq &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SeqEnforcer.html#ab7b09c947a59e82422879e793f0cf14e">time_point</a>&#160;</td>
<td class="paramname"><em>now</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Seq&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1ValidationParms.html">ValidationParms</a> const &amp;&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Try advancing the largest observed validation ledger sequence. </p>
<p >Try setting the largest validation sequence observed, but return false if it violates the invariant that a validation must be larger than all unexpired validation sequence numbers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">now</td><td>The current time </td></tr>
<tr><td class="paramname">s</td><td>The sequence number we want to validate </td></tr>
<tr><td class="paramname">p</td><td>Validation parameters</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the validation satisfies the invariant </dd></dl>
<p class="definition">Definition at line <a class="el" href="Validations_8h_source.html#l00118">118</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="a0028fb17fa1d035b986b9edf4cd59776" name="a0028fb17fa1d035b986b9edf4cd59776"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0028fb17fa1d035b986b9edf4cd59776">&#9670;&#160;</a></span>largest()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq &gt; </div>
<table class="memname">
<tr>
<td class="memname">Seq <a class="el" href="classripple_1_1SeqEnforcer.html">ripple::SeqEnforcer</a>&lt; Seq &gt;::largest </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="Validations_8h_source.html#l00130">130</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a01e9f27df73544b7d44c634cd61541be" name="a01e9f27df73544b7d44c634cd61541be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01e9f27df73544b7d44c634cd61541be">&#9670;&#160;</a></span>seq_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Seq <a class="el" href="classripple_1_1SeqEnforcer.html">ripple::SeqEnforcer</a>&lt; Seq &gt;::seq_ {0}</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="Validations_8h_source.html#l00101">101</a> of file <a class="el" href="Validations_8h_source.html">Validations.h</a>.</p>
</div>
</div>
<a id="aff5b1f37122ea7cd83dd2d4c9db21bc2" name="aff5b1f37122ea7cd83dd2d4c9db21bc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff5b1f37122ea7cd83dd2d4c9db21bc2">&#9670;&#160;</a></span>when_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SeqEnforcer.html#ab7b09c947a59e82422879e793f0cf14e">time_point</a> <a class="el" href="classripple_1_1SeqEnforcer.html">ripple::SeqEnforcer</a>&lt; Seq &gt;::when_</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="Validations_8h_source.html#l00102">102</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink