mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
142 lines
17 KiB
HTML
142 lines
17 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: DecodedBlob.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 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">DecodedBlob.h</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">#ifndef RIPPLE_NODESTORE_DECODEDBLOB_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_NODESTORE_DECODEDBLOB_H_INCLUDED</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="preprocessor">#include <ripple/nodestore/NodeObject.h></span></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="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>NodeStore {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html">DecodedBlob</a></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#aea8993fa60dbff7589068996410c3c99">DecodedBlob</a> (<span class="keywordtype">void</span> <span class="keyword">const</span>* key, <span class="keywordtype">void</span> <span class="keyword">const</span>* value, <span class="keywordtype">int</span> valueBytes);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4b3301f4f3697bd09ebf977c8d3f056f"> 45</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4b3301f4f3697bd09ebf977c8d3f056f">wasOk</a> () const noexcept { <span class="keywordflow">return</span> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a198eb16c758d4c065146a66f2551ae23">m_success</a>; }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<NodeObject></a> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a20fe9b3942f79cb6b610114469e827c1">createObject</a> ();</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a198eb16c758d4c065146a66f2551ae23"> 51</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a198eb16c758d4c065146a66f2551ae23">m_success</a>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#af2e9cc1b389ccba9d72912072d732730"> 53</a></span>  <span class="keywordtype">void</span> <span class="keyword">const</span>* <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#af2e9cc1b389ccba9d72912072d732730">m_key</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a0cd2ea7a33fae2afabd34c94c1914029"> 54</a></span>  <a class="code" href="namespaceripple.html#a57d7e7b27df7e719fdf5569f96be60a3">NodeObjectType</a> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a0cd2ea7a33fae2afabd34c94c1914029">m_objectType</a>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4677c0c6b2ac767333f259566d9343e7"> 55</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4677c0c6b2ac767333f259566d9343e7">m_objectData</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a503af8a68bd267a1db8a3b3484e2d94e"> 56</a></span>  <span class="keywordtype">int</span> <a class="code" href="classripple_1_1NodeStore_1_1DecodedBlob.html#a503af8a68bd267a1db8a3b3484e2d94e">m_dataBytes</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </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>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_a4b3301f4f3697bd09ebf977c8d3f056f"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4b3301f4f3697bd09ebf977c8d3f056f">ripple::NodeStore::DecodedBlob::wasOk</a></div><div class="ttdeci">bool wasOk() const noexcept</div><div class="ttdoc">Determine if the decoding was successful.</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00045">DecodedBlob.h:45</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html">ripple::NodeStore::DecodedBlob</a></div><div class="ttdoc">Parsed key/value blob into NodeObject components.</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00038">DecodedBlob.h:38</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< NodeObject ></a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_af2e9cc1b389ccba9d72912072d732730"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#af2e9cc1b389ccba9d72912072d732730">ripple::NodeStore::DecodedBlob::m_key</a></div><div class="ttdeci">void const * m_key</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00053">DecodedBlob.h:53</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_a198eb16c758d4c065146a66f2551ae23"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a198eb16c758d4c065146a66f2551ae23">ripple::NodeStore::DecodedBlob::m_success</a></div><div class="ttdeci">bool m_success</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00051">DecodedBlob.h:51</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_1NodeStore_1_1DecodedBlob_html_a4677c0c6b2ac767333f259566d9343e7"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a4677c0c6b2ac767333f259566d9343e7">ripple::NodeStore::DecodedBlob::m_objectData</a></div><div class="ttdeci">unsigned char const * m_objectData</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00055">DecodedBlob.h:55</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_a20fe9b3942f79cb6b610114469e827c1"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a20fe9b3942f79cb6b610114469e827c1">ripple::NodeStore::DecodedBlob::createObject</a></div><div class="ttdeci">std::shared_ptr< NodeObject > createObject()</div><div class="ttdoc">Create a NodeObject from this data.</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8cpp_source.html#l00073">DecodedBlob.cpp:73</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_a503af8a68bd267a1db8a3b3484e2d94e"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a503af8a68bd267a1db8a3b3484e2d94e">ripple::NodeStore::DecodedBlob::m_dataBytes</a></div><div class="ttdeci">int m_dataBytes</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00056">DecodedBlob.h:56</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_a0cd2ea7a33fae2afabd34c94c1914029"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#a0cd2ea7a33fae2afabd34c94c1914029">ripple::NodeStore::DecodedBlob::m_objectType</a></div><div class="ttdeci">NodeObjectType m_objectType</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8h_source.html#l00054">DecodedBlob.h:54</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1NodeStore_1_1DecodedBlob_html_aea8993fa60dbff7589068996410c3c99"><div class="ttname"><a href="classripple_1_1NodeStore_1_1DecodedBlob.html#aea8993fa60dbff7589068996410c3c99">ripple::NodeStore::DecodedBlob::DecodedBlob</a></div><div class="ttdeci">DecodedBlob(void const *key, void const *value, int valueBytes)</div><div class="ttdoc">Construct the decoded blob from raw data.</div><div class="ttdef"><b>Definition:</b> <a href="DecodedBlob_8cpp_source.html#l00028">DecodedBlob.cpp:28</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>
|
|
<!-- 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>
|