ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ba075f68950c370c589f57fd777b9a9b9f8bde8
rippled/NodeObject_8cpp_source.html
bthomee 4ba075f689 deploy: 2406b28e64
2025-03-11 18:21:06 +00:00

164 lines
19 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: 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.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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_7ce8509406ee125b7d32b7e664ae4e18.html">nodestore</a></li><li class="navelem"><a class="el" href="dir_9316ae2f34c7b7c8d3f14ce0f886f64c.html">detail</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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></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><span class="preprocessor">#include &lt;xrpld/nodestore/NodeObject.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</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="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</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><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a9ed8cbe8f79925b58d9c9eca7ef4f385"> 28</a></span><a class="code hl_function" href="classripple_1_1NodeObject.html#a9ed8cbe8f79925b58d9c9eca7ef4f385">NodeObject::NodeObject</a>(</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_enumeration" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a> type,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&amp;&amp; data,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_struct" href="structripple_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> : mType(type), mHash(hash), mData(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(data))</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</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> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</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="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a841bb9bba547efbd89b240fa9c1cf146"> 38</a></span><a class="code hl_function" href="classripple_1_1NodeObject.html#a841bb9bba547efbd89b240fa9c1cf146">NodeObject::createObject</a>(<a class="code hl_enumeration" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">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="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">return</span> std::make_shared&lt;NodeObject&gt;(</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> type, std::move(data), hash, <a class="code hl_struct" href="structripple_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>());</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>}</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_enumeration" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#ad29adccfdb5fbd2a9aac66bd2fbd8b89"> 45</a></span><a class="code hl_function" href="classripple_1_1NodeObject.html#ad29adccfdb5fbd2a9aac66bd2fbd8b89">NodeObject::getType</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1NodeObject.html#a3e053c9bb281471298c89938b2576467">mType</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>}</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a0606175e4e12003b1351c78ac44facb5"> 51</a></span><a class="code hl_function" href="classripple_1_1NodeObject.html#a0606175e4e12003b1351c78ac44facb5">NodeObject::getHash</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1NodeObject.html#a3f8aa5408a9b07ce178b210c193d4576">mHash</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>}</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</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="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be"> 57</a></span><a class="code hl_function" href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be">NodeObject::getData</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1NodeObject.html#a08a1e0090da1dfbd34fca6f9ea57a84a">mData</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>}</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="ttc" id="aclassripple_1_1NodeObject_html_a0606175e4e12003b1351c78ac44facb5"><div class="ttname"><a href="classripple_1_1NodeObject.html#a0606175e4e12003b1351c78ac44facb5">ripple::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#l00051">NodeObject.cpp:51</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_a08a1e0090da1dfbd34fca6f9ea57a84a"><div class="ttname"><a href="classripple_1_1NodeObject.html#a08a1e0090da1dfbd34fca6f9ea57a84a">ripple::NodeObject::mData</a></div><div class="ttdeci">Blob const mData</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8h_source.html#l00100">NodeObject.h:100</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_a3e053c9bb281471298c89938b2576467"><div class="ttname"><a href="classripple_1_1NodeObject.html#a3e053c9bb281471298c89938b2576467">ripple::NodeObject::mType</a></div><div class="ttdeci">NodeObjectType const mType</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8h_source.html#l00098">NodeObject.h:98</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_a3f8aa5408a9b07ce178b210c193d4576"><div class="ttname"><a href="classripple_1_1NodeObject.html#a3f8aa5408a9b07ce178b210c193d4576">ripple::NodeObject::mHash</a></div><div class="ttdeci">uint256 const mHash</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8h_source.html#l00099">NodeObject.h:99</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_a841bb9bba547efbd89b240fa9c1cf146"><div class="ttname"><a href="classripple_1_1NodeObject.html#a841bb9bba547efbd89b240fa9c1cf146">ripple::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#l00038">NodeObject.cpp:38</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_a9ed8cbe8f79925b58d9c9eca7ef4f385"><div class="ttname"><a href="classripple_1_1NodeObject.html#a9ed8cbe8f79925b58d9c9eca7ef4f385">ripple::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#l00028">NodeObject.cpp:28</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_ab2ed9996f528dfb5ac1e26e7fa3ab2be"><div class="ttname"><a href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be">ripple::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#l00057">NodeObject.cpp:57</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeObject_html_ad29adccfdb5fbd2a9aac66bd2fbd8b89"><div class="ttname"><a href="classripple_1_1NodeObject.html#ad29adccfdb5fbd2a9aac66bd2fbd8b89">ripple::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#l00045">NodeObject.cpp:45</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</a></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="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#l00026">algorithm.h:26</a></div></div>
<div class="ttc" id="anamespaceripple_html_a57d7e7b27df7e719fdf5569f96be60a3"><div class="ttname"><a href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">ripple::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#l00032">NodeObject.h:32</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="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="astructripple_1_1NodeObject_1_1PrivateAccess_html"><div class="ttname"><a href="structripple_1_1NodeObject_1_1PrivateAccess.html">ripple::NodeObject::PrivateAccess</a></div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8h_source.html#l00058">NodeObject.h:59</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink