mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
158 lines
18 KiB
HTML
158 lines
18 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: 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 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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_ceb6d1bc218d15504336f945ff1322da.html">nodestore</a></li><li class="navelem"><a class="el" href="dir_1eae1e3c362aa357dbf8694343222a03.html">impl</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/nodestore/NodeObject.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a9ed8cbe8f79925b58d9c9eca7ef4f385"> 27</a></span> <a class="code" href="classripple_1_1NodeObject.html#a9ed8cbe8f79925b58d9c9eca7ef4f385">NodeObject::NodeObject</a>(</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a> type,</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&& data,</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& hash,</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="structripple_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>)</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  : mType(type), mHash(hash), mData(<a class="code" href="namespacestd.html">std</a>::move(data))</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<NodeObject></a></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a841bb9bba547efbd89b240fa9c1cf146"> 37</a></span> <a class="code" href="classripple_1_1NodeObject.html#a841bb9bba547efbd89b240fa9c1cf146">NodeObject::createObject</a>(<a class="code" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a> type, <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&& data, <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& hash)</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">return</span> std::make_shared<NodeObject>(</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  type, std::move(data), hash, <a class="code" href="structripple_1_1NodeObject_1_1PrivateAccess.html">PrivateAccess</a>());</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#ad29adccfdb5fbd2a9aac66bd2fbd8b89"> 44</a></span> <a class="code" href="classripple_1_1NodeObject.html#ad29adccfdb5fbd2a9aac66bd2fbd8b89">NodeObject::getType</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1NodeObject.html#a159339b44a5fae85a9ad86b486817519">mType</a>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#a0606175e4e12003b1351c78ac44facb5"> 50</a></span> <a class="code" href="classripple_1_1NodeObject.html#a0606175e4e12003b1351c78ac44facb5">NodeObject::getHash</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1NodeObject.html#a6ad47f35682d6d6cb59c8d8c4b868cbd">mHash</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be"> 56</a></span> <a class="code" href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be">NodeObject::getData</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1NodeObject.html#a0193e90bf809f016d4dbdd6f58458596">mData</a>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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< NodeObject ></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< unsigned char ></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="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< NodeObject > createObject(NodeObjectType type, Blob &&data, uint256 const &hash)</div><div class="ttdoc">Create an object from fields.</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8cpp_source.html#l00037">NodeObject.cpp:37</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeObject_html_a6ad47f35682d6d6cb59c8d8c4b868cbd"><div class="ttname"><a href="classripple_1_1NodeObject.html#a6ad47f35682d6d6cb59c8d8c4b868cbd">ripple::NodeObject::mHash</a></div><div class="ttdeci">const uint256 mHash</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_a0193e90bf809f016d4dbdd6f58458596"><div class="ttname"><a href="classripple_1_1NodeObject.html#a0193e90bf809f016d4dbdd6f58458596">ripple::NodeObject::mData</a></div><div class="ttdeci">const Blob mData</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_ab2ed9996f528dfb5ac1e26e7fa3ab2be"><div class="ttname"><a href="classripple_1_1NodeObject.html#ab2ed9996f528dfb5ac1e26e7fa3ab2be">ripple::NodeObject::getData</a></div><div class="ttdeci">Blob const & getData() const</div><div class="ttdoc">Returns the underlying data.</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8cpp_source.html#l00056">NodeObject.cpp:56</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#l00044">NodeObject.cpp:44</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< 256 ></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="aclassripple_1_1NodeObject_html_a159339b44a5fae85a9ad86b486817519"><div class="ttname"><a href="classripple_1_1NodeObject.html#a159339b44a5fae85a9ad86b486817519">ripple::NodeObject::mType</a></div><div class="ttdeci">const NodeObjectType mType</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8h_source.html#l00097">NodeObject.h:97</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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="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 & 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#l00050">NodeObject.cpp:50</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 &&data, uint256 const &hash, PrivateAccess)</div><div class="ttdef"><b>Definition:</b> <a href="NodeObject_8cpp_source.html#l00027">NodeObject.cpp:27</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#l00057">NodeObject.h:57</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|