Files
rippled/NodeObject_8cpp_source.html
2026-01-28 10:13:01 -08:00

156 lines
16 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: NodeObject.cpp 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_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_a59c1a58e5e6f521a28fe23865b09e68.html">nodestore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">NodeObject.cpp</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">#include &lt;xrpl/nodestore/NodeObject.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeObject.html#a5ec0ecc2e65e329ac11737b97c5a152f"> 9</a></span><a class="code hl_function" href="classxrpl_1_1NodeObject.html#a5ec0ecc2e65e329ac11737b97c5a152f">NodeObject::NodeObject</a>(<a class="code hl_enumeration" href="namespacexrpl.html#a663b0ac7aab40440c7da9e3ea84a2ebf">NodeObjectType</a> type, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&amp;&amp; data, <a class="code hl_class" href="classxrpl_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash, <a class="code hl_struct" href="structxrpl_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>)</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> : mType(type), mHash(hash), mData(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(data))</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>}</div>
</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;NodeObject&gt;</a></div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="}">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeObject.html#a728cb3a174442ab94254cdb5ff1e8fe1"> 15</a></span><a class="code hl_function" href="classxrpl_1_1NodeObject.html#a728cb3a174442ab94254cdb5ff1e8fe1">NodeObject::createObject</a>(<a class="code hl_enumeration" href="namespacexrpl.html#a663b0ac7aab40440c7da9e3ea84a2ebf">NodeObjectType</a> type, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&amp;&amp; data, <a class="code hl_class" href="classxrpl_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash)</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::make_shared&lt;NodeObject&gt;</a>(type, std::move(data), hash, <a class="code hl_struct" href="structxrpl_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>());</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>}</div>
</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_enumeration" href="namespacexrpl.html#a663b0ac7aab40440c7da9e3ea84a2ebf">NodeObjectType</a></div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeObject.html#a7188b5f1c1b5dc9a7e9c5dea232d6a2a"> 21</a></span><a class="code hl_function" href="classxrpl_1_1NodeObject.html#a7188b5f1c1b5dc9a7e9c5dea232d6a2a">NodeObject::getType</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classxrpl_1_1NodeObject.html#aae1772295f64d2cbc08de4a2e944881c">mType</a>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><a class="code hl_class" href="classxrpl_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeObject.html#ae7f2377f70b22edb110f1ec903bd572b"> 27</a></span><a class="code hl_function" href="classxrpl_1_1NodeObject.html#ae7f2377f70b22edb110f1ec903bd572b">NodeObject::getHash</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classxrpl_1_1NodeObject.html#a9375abc053afd902c51e840ce7ac2881">mHash</a>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>}</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeObject.html#ae98a73ca7780e8494278faa5c6e04820"> 33</a></span><a class="code hl_function" href="classxrpl_1_1NodeObject.html#ae98a73ca7780e8494278faa5c6e04820">NodeObject::getData</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classxrpl_1_1NodeObject.html#a13327efebfa6284d9a5f059c24179ed7">mData</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_a13327efebfa6284d9a5f059c24179ed7"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#a13327efebfa6284d9a5f059c24179ed7">xrpl::NodeObject::mData</a></div><div class="ttdeci">Blob const mData</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8h_source.html#l00077">NodeObject.h:77</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_a5ec0ecc2e65e329ac11737b97c5a152f"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#a5ec0ecc2e65e329ac11737b97c5a152f">xrpl::NodeObject::NodeObject</a></div><div class="ttdeci">NodeObject(NodeObjectType type, Blob &amp;&amp;data, uint256 const &amp;hash, PrivateAccess)</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8cpp_source.html#l00009">NodeObject.cpp:9</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_a7188b5f1c1b5dc9a7e9c5dea232d6a2a"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#a7188b5f1c1b5dc9a7e9c5dea232d6a2a">xrpl::NodeObject::getType</a></div><div class="ttdeci">NodeObjectType getType() const</div><div class="ttdoc">Returns the type of this object.</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8cpp_source.html#l00021">NodeObject.cpp:21</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_a728cb3a174442ab94254cdb5ff1e8fe1"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#a728cb3a174442ab94254cdb5ff1e8fe1">xrpl::NodeObject::createObject</a></div><div class="ttdeci">static std::shared_ptr&lt; NodeObject &gt; createObject(NodeObjectType type, Blob &amp;&amp;data, uint256 const &amp;hash)</div><div class="ttdoc">Create an object from fields.</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8cpp_source.html#l00015">NodeObject.cpp:15</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_a9375abc053afd902c51e840ce7ac2881"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#a9375abc053afd902c51e840ce7ac2881">xrpl::NodeObject::mHash</a></div><div class="ttdeci">uint256 const mHash</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8h_source.html#l00076">NodeObject.h:76</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_aae1772295f64d2cbc08de4a2e944881c"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#aae1772295f64d2cbc08de4a2e944881c">xrpl::NodeObject::mType</a></div><div class="ttdeci">NodeObjectType const mType</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8h_source.html#l00075">NodeObject.h:75</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_ae7f2377f70b22edb110f1ec903bd572b"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#ae7f2377f70b22edb110f1ec903bd572b">xrpl::NodeObject::getHash</a></div><div class="ttdeci">uint256 const &amp; getHash() const</div><div class="ttdoc">Returns the hash of the data.</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8cpp_source.html#l00027">NodeObject.cpp:27</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeObject_html_ae98a73ca7780e8494278faa5c6e04820"><div class="ttname"><a href="classxrpl_1_1NodeObject.html#ae98a73ca7780e8494278faa5c6e04820">xrpl::NodeObject::getData</a></div><div class="ttdeci">Blob const &amp; getData() const</div><div class="ttdoc">Returns the underlying data.</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8cpp_source.html#l00033">NodeObject.cpp:33</a></div></div>
<div class="ttc" id="aclassxrpl_1_1base__uint_html"><div class="ttname"><a href="classxrpl_1_1base__uint.html">xrpl::base_uint&lt; 256 &gt;</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</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 class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="anamespacexrpl_html_a663b0ac7aab40440c7da9e3ea84a2ebf"><div class="ttname"><a href="namespacexrpl.html#a663b0ac7aab40440c7da9e3ea84a2ebf">xrpl::NodeObjectType</a></div><div class="ttdeci">NodeObjectType</div><div class="ttdoc">The types of node objects.</div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8h_source.html#l00013">NodeObject.h:13</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astructxrpl_1_1NodeObject_1_1PrivateAccess_html"><div class="ttname"><a href="structxrpl_1_1NodeObject_1_1PrivateAccess.html">xrpl::NodeObject::PrivateAccess</a></div><div class="ttdef"><b>Definition</b> <a href="NodeObject_8h_source.html#l00039">NodeObject.h:40</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt; unsigned char &gt;</a></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>