Files
rippled/classripple_1_1SpanTip.html
2023-04-11 22:54:00 +00:00

345 lines
21 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::SpanTip&lt; Ledger &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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_1SpanTip.html">SpanTip</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1SpanTip-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::SpanTip&lt; Ledger &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The tip of a span of ledger ancestry.
<a href="classripple_1_1SpanTip.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::SpanTip&lt; Ledger &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SpanTip__coll__graph.png" border="0" usemap="#ripple_1_1SpanTip_3_01Ledger_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1SpanTip_3_01Ledger_01_4_coll__map" id="ripple_1_1SpanTip_3_01Ledger_01_4_coll__map">
<area shape="rect" title="The tip of a span of ledger ancestry." alt="" coords="2440,531,2633,558"/>
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="2191,531,2302,558"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1837,379,2003,420"/>
<area shape="rect" href="classripple_1_1DigestAwareReadView.html" title="ReadView that associates keys with digests." alt="" coords="1813,277,2027,303"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1557,149,1688,175"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1832,134,2008,190"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1832,5,2008,47"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2147,190,2347,217"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2149,50,2344,77"/>
<area shape="rect" href="classripple_1_1TxsRawView.html" title="Interface for changing ledger entries with transactions." alt="" coords="1845,327,1995,354"/>
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="1559,327,1686,354"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1839,844,2001,885"/>
<area shape="rect" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan&#45;out of 16 and a Merkle tree." alt="" coords="1859,579,1981,606"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,598,108,625"/>
<area shape="rect" href="classripple_1_1SHAMapTreeNode.html" title=" " alt="" coords="1255,623,1437,650"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="250,771,418,812"/>
<area shape="rect" href="structripple_1_1LedgerInfo.html" title="Information about the notional ledger backing the view." alt="" coords="939,485,1075,511"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1537,613,1708,655"/>
<area shape="rect" href="classripple_1_1SHAMapHash.html" title=" " alt="" coords="930,674,1085,701"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="559,715,701,756"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="559,801,701,843"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="290,697,378,723"/>
<area shape="rect" href="classripple_1_1Family.html" title=" " alt="" coords="1567,679,1678,706"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1567,730,1678,757"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1273,730,1419,757"/>
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1869,793,1971,819"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1537,797,1708,839"/>
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1277,811,1415,838"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="904,725,1111,781"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="933,871,1082,927"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="930,805,1085,847"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="1874,630,1966,657"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="552,389,708,431"/>
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="559,325,701,351"/>
<area shape="rect" href="structripple_1_1Fees.html" title="Reflects the fee settings for a particular ledger." alt="" coords="1135,375,1231,402"/>
<area shape="rect" title=" " alt="" coords="251,435,417,476"/>
<area shape="rect" title=" " alt="" coords="221,201,447,227"/>
<area shape="rect" title=" " alt="" coords="229,252,439,293"/>
<area shape="rect" title=" " alt="" coords="227,317,441,359"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="287,383,381,410"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="544,455,716,496"/>
</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 name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab66b92a293781891d0a2a84aef250d00"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> = typename Ledger::Seq</td></tr>
<tr class="separator:ab66b92a293781891d0a2a84aef250d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a419171187a9ff885f04020822527b3fc"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a> = typename Ledger::ID</td></tr>
<tr class="separator:a419171187a9ff885f04020822527b3fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a64899aebb12a10ae1aa4e5f7068c3259"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a64899aebb12a10ae1aa4e5f7068c3259">SpanTip</a> (<a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> s, <a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a> i, <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const lgr)</td></tr>
<tr class="separator:a64899aebb12a10ae1aa4e5f7068c3259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5488a3015aa557232af21e9426f334d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a5488a3015aa557232af21e9426f334d3">ancestor</a> (<a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> const &amp;s) const</td></tr>
<tr class="memdesc:a5488a3015aa557232af21e9426f334d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup the ID of an ancestor of the tip ledger. <a href="classripple_1_1SpanTip.html#a5488a3015aa557232af21e9426f334d3">More...</a><br /></td></tr>
<tr class="separator:a5488a3015aa557232af21e9426f334d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a926a2d01cd31804bdb565aa59dec323c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a926a2d01cd31804bdb565aa59dec323c">seq</a></td></tr>
<tr class="separator:a926a2d01cd31804bdb565aa59dec323c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b23098e0b59b2d72caafac463c0ba3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a6b23098e0b59b2d72caafac463c0ba3b">id</a></td></tr>
<tr class="separator:a6b23098e0b59b2d72caafac463c0ba3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a6f7e3a056d352c18f0adb283349af2a5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classripple_1_1Ledger.html">Ledger</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SpanTip.html#a6f7e3a056d352c18f0adb283349af2a5">ledger</a></td></tr>
<tr class="separator:a6f7e3a056d352c18f0adb283349af2a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Ledger&gt;<br />
class ripple::SpanTip&lt; Ledger &gt;</h3>
<p>The tip of a span of ledger ancestry. </p>
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00037">37</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab66b92a293781891d0a2a84aef250d00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab66b92a293781891d0a2a84aef250d00">&#9670;&nbsp;</a></span>Seq</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::<a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> = typename Ledger::Seq</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00040">40</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<a id="a419171187a9ff885f04020822527b3fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a419171187a9ff885f04020822527b3fc">&#9670;&nbsp;</a></span>ID</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::<a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a> = typename Ledger::ID</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00041">41</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a64899aebb12a10ae1aa4e5f7068c3259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64899aebb12a10ae1aa4e5f7068c3259">&#9670;&nbsp;</a></span>SpanTip()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::<a class="el" href="classripple_1_1SpanTip.html">SpanTip</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a>&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a>&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Ledger.html">Ledger</a> const&#160;</td>
<td class="paramname"><em>lgr</em>&#160;</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="LedgerTrie_8h_source.html#l00043">43</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5488a3015aa557232af21e9426f334d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5488a3015aa557232af21e9426f334d3">&#9670;&nbsp;</a></span>ancestor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a> <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::ancestor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> const &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Lookup the ID of an ancestor of the tip ledger. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The sequence number of the ancestor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the ancestor with that sequence number</dd></dl>
<dl class="section note"><dt>Note</dt><dd>s must be less than or equal to the sequence number of the tip ledger </dd></dl>
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00062">62</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a926a2d01cd31804bdb565aa59dec323c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a926a2d01cd31804bdb565aa59dec323c">&#9670;&nbsp;</a></span>seq</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SpanTip.html#ab66b92a293781891d0a2a84aef250d00">Seq</a> <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::seq</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00049">49</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<a id="a6b23098e0b59b2d72caafac463c0ba3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b23098e0b59b2d72caafac463c0ba3b">&#9670;&nbsp;</a></span>id</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SpanTip.html#a419171187a9ff885f04020822527b3fc">ID</a> <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::id</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="LedgerTrie_8h_source.html#l00051">51</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
<a id="a6f7e3a056d352c18f0adb283349af2a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f7e3a056d352c18f0adb283349af2a5">&#9670;&nbsp;</a></span>ledger</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Ledger &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classripple_1_1Ledger.html">Ledger</a> <a class="el" href="classripple_1_1SpanTip.html">ripple::SpanTip</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> &gt;::ledger</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="LedgerTrie_8h_source.html#l00069">69</a> of file <a class="el" href="LedgerTrie_8h_source.html">LedgerTrie.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>