ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2b45155992b7b2747eb341ac740c4e03e32bea0f
rippled/SHAMapLeafNode_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

175 lines
20 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SHAMapLeafNode.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_292da32077129148230df7f03daa34af.html">shamap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">SHAMapLeafNode.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_SHAMAP_SHAMAPLEAFNODE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SHAMAP_SHAMAPLEAFNODE_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/shamap/SHAMapItem.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/shamap/SHAMapTreeNode.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1SHAMapTreeNode.html">SHAMapTreeNode</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html#a8629b790383fb14f7fab214002e793ee"> 14</a></span> boost::intrusive_ptr&lt;SHAMapItem const&gt; <a class="code hl_variable" href="classripple_1_1SHAMapLeafNode.html#a8629b790383fb14f7fab214002e793ee">item_</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a>(</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> boost::intrusive_ptr&lt;SHAMapItem const&gt; item,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code hl_function" href="group__SHAMap.html#gac9adec7146a8bea60fe6acf6c1ed98d1">cowid</a>);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a>(</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> boost::intrusive_ptr&lt;SHAMapItem const&gt; item,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code hl_function" href="group__SHAMap.html#gac9adec7146a8bea60fe6acf6c1ed98d1">cowid</a>,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_class" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>&amp; hash);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html#ae9fb8b34f68068af8132f4799c862f71"> 26</a></span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#ae9fb8b34f68068af8132f4799c862f71">SHAMapLeafNode</a>(<a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a>&amp;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html#a1073515afa378a278effb467e7f0e3b4"> 28</a></span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#a1073515afa378a278effb467e7f0e3b4">operator=</a>(<a class="code hl_class" href="classripple_1_1SHAMapLeafNode.html">SHAMapLeafNode</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="}">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html#a89119bf73fc1ac226331cd7948e92a2c"> 31</a></span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#a89119bf73fc1ac226331cd7948e92a2c">isLeaf</a>() const final<span class="keyword"> override</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="}">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapLeafNode.html#a80ab1af0864fa332e24e4403efa2ccdd"> 37</a></span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#a80ab1af0864fa332e24e4403efa2ccdd">isInner</a>() const final<span class="keyword"> override</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#af777f590d86414bb7a88decd5b001110">invariants</a>(<span class="keywordtype">bool</span> is_root = <span class="keyword">false</span>) const final override;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>public:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_namespace" href="namespaceboost.html">boost</a>::intrusive_ptr&lt;<a class="code hl_class" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const&gt; const&amp;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#afee48bd94530b5ad6dfe4a403d8455c4">peekItem</a>() const;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#ada83f0df874a2c0050a54daf1d3ea883">setItem</a>(<a class="code hl_namespace" href="namespaceboost.html">boost</a>::intrusive_ptr&lt;<a class="code hl_class" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const&gt; i);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_function" href="classripple_1_1SHAMapLeafNode.html#a281c972c705ae159866a146f3556c4e6">getString</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> const&amp;) const final override;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1SHAMapHash_html"><div class="ttname"><a href="classripple_1_1SHAMapHash.html">ripple::SHAMapHash</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapHash_8h_source.html#l00014">SHAMapHash.h:15</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapItem_html"><div class="ttname"><a href="classripple_1_1SHAMapItem.html">ripple::SHAMapItem</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapItem_8h_source.html#l00016">SHAMapItem.h:17</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html">ripple::SHAMapLeafNode</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8h_source.html#l00011">SHAMapLeafNode.h:12</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_a1073515afa378a278effb467e7f0e3b4"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#a1073515afa378a278effb467e7f0e3b4">ripple::SHAMapLeafNode::operator=</a></div><div class="ttdeci">SHAMapLeafNode &amp; operator=(SHAMapLeafNode const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_a281c972c705ae159866a146f3556c4e6"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#a281c972c705ae159866a146f3556c4e6">ripple::SHAMapLeafNode::getString</a></div><div class="ttdeci">std::string getString(SHAMapNodeID const &amp;) const final override</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8cpp_source.html#l00049">SHAMapLeafNode.cpp:49</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_a80ab1af0864fa332e24e4403efa2ccdd"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#a80ab1af0864fa332e24e4403efa2ccdd">ripple::SHAMapLeafNode::isInner</a></div><div class="ttdeci">bool isInner() const final override</div><div class="ttdoc">Determines if this is an inner node.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8h_source.html#l00037">SHAMapLeafNode.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_a8629b790383fb14f7fab214002e793ee"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#a8629b790383fb14f7fab214002e793ee">ripple::SHAMapLeafNode::item_</a></div><div class="ttdeci">boost::intrusive_ptr&lt; SHAMapItem const &gt; item_</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8h_source.html#l00014">SHAMapLeafNode.h:14</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_a89119bf73fc1ac226331cd7948e92a2c"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#a89119bf73fc1ac226331cd7948e92a2c">ripple::SHAMapLeafNode::isLeaf</a></div><div class="ttdeci">bool isLeaf() const final override</div><div class="ttdoc">Determines if this is a leaf node.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8h_source.html#l00031">SHAMapLeafNode.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_ada83f0df874a2c0050a54daf1d3ea883"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#ada83f0df874a2c0050a54daf1d3ea883">ripple::SHAMapLeafNode::setItem</a></div><div class="ttdeci">bool setItem(boost::intrusive_ptr&lt; SHAMapItem const &gt; i)</div><div class="ttdoc">Set the item that this node points to and update the node's hash.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8cpp_source.html#l00036">SHAMapLeafNode.cpp:36</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_ae9fb8b34f68068af8132f4799c862f71"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#ae9fb8b34f68068af8132f4799c862f71">ripple::SHAMapLeafNode::SHAMapLeafNode</a></div><div class="ttdeci">SHAMapLeafNode(SHAMapLeafNode const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_af777f590d86414bb7a88decd5b001110"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#af777f590d86414bb7a88decd5b001110">ripple::SHAMapLeafNode::invariants</a></div><div class="ttdeci">void invariants(bool is_root=false) const final override</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8cpp_source.html#l00074">SHAMapLeafNode.cpp:74</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapLeafNode_html_afee48bd94530b5ad6dfe4a403d8455c4"><div class="ttname"><a href="classripple_1_1SHAMapLeafNode.html#afee48bd94530b5ad6dfe4a403d8455c4">ripple::SHAMapLeafNode::peekItem</a></div><div class="ttdeci">boost::intrusive_ptr&lt; SHAMapItem const &gt; const &amp; peekItem() const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapLeafNode_8cpp_source.html#l00030">SHAMapLeafNode.cpp:30</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html">ripple::SHAMapNodeID</a></div><div class="ttdoc">Identifies a node inside a SHAMap.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00014">SHAMapNodeID.h:15</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapTreeNode_html"><div class="ttname"><a href="classripple_1_1SHAMapTreeNode.html">ripple::SHAMapTreeNode</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapTreeNode_8h_source.html#l00031">SHAMapTreeNode.h:32</a></div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="agroup__SHAMap_html_gac9adec7146a8bea60fe6acf6c1ed98d1"><div class="ttname"><a href="group__SHAMap.html#gac9adec7146a8bea60fe6acf6c1ed98d1">ripple::SHAMapTreeNode::cowid</a></div><div class="ttdeci">std::uint32_t cowid() const</div><div class="ttdoc">Returns the SHAMap that owns this node.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapTreeNode_8h_source.html#l00098">SHAMapTreeNode.h:98</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="anamespaceboost_html"><div class="ttname"><a href="namespaceboost.html">boost</a></div><div class="ttdef"><b>Definition</b> <a href="IPAddress_8h_source.html#l00086">IPAddress.h:86</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
</div><!-- fragment --></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