ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f42ca4239534b42d7f4542459b491656b71e9c6c
rippled/structripple_1_1NodeStore_1_1EncodedBlob.html
manojsdoshi 430f6c0cf3 deploy: 023f5704d0
2020-04-24 01:09:47 +00:00

275 lines
13 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">
<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: ripple::NodeStore::EncodedBlob Struct Reference</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&amp;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&amp;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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a></li><li class="navelem"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html">EncodedBlob</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="structripple_1_1NodeStore_1_1EncodedBlob-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::NodeStore::EncodedBlob Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility for producing flattened node objects.
<a href="structripple_1_1NodeStore_1_1EncodedBlob.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::NodeStore::EncodedBlob:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1NodeStore_1_1EncodedBlob__coll__graph.png" border="0" usemap="#ripple_1_1NodeStore_1_1EncodedBlob_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1NodeStore_1_1EncodedBlob_coll__map" id="ripple_1_1NodeStore_1_1EncodedBlob_coll__map">
<area shape="rect" title="Utility for producing flattened node objects." alt="" coords="119,288,262,329"/>
<area shape="rect" href="classripple_1_1Buffer.html" title="Like std::vector&lt;char&gt; but better." alt="" coords="137,199,244,225"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="5,95,160,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="35,5,130,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="184,102,272,129"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1b3f76ab2c8935a08fb71f77e2100ba4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#a1b3f76ab2c8935a08fb71f77e2100ba4">prepare</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; const &amp;object)</td></tr>
<tr class="separator:a1b3f76ab2c8935a08fb71f77e2100ba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e302b42921788cc860be6e51f759d76"><td class="memItemLeft" align="right" valign="top">void const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#a5e302b42921788cc860be6e51f759d76">getKey</a> () const noexcept</td></tr>
<tr class="separator:a5e302b42921788cc860be6e51f759d76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a709e5c71eeb5b9a9eb635b9c02143815"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#a709e5c71eeb5b9a9eb635b9c02143815">getSize</a> () const noexcept</td></tr>
<tr class="separator:a709e5c71eeb5b9a9eb635b9c02143815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af168e5bddf805f34c09e254d1b078bfa"><td class="memItemLeft" align="right" valign="top">void const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#af168e5bddf805f34c09e254d1b078bfa">getData</a> () const noexcept</td></tr>
<tr class="separator:af168e5bddf805f34c09e254d1b078bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:adcf74402099226d78d3a94e92ccac80d"><td class="memItemLeft" align="right" valign="top">void const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#adcf74402099226d78d3a94e92ccac80d">m_key</a></td></tr>
<tr class="separator:adcf74402099226d78d3a94e92ccac80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6af4ac37c23417a3fc82359fd0f71ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Buffer.html">Buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1EncodedBlob.html#aa6af4ac37c23417a3fc82359fd0f71ba">m_data</a></td></tr>
<tr class="separator:aa6af4ac37c23417a3fc82359fd0f71ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility for producing flattened node objects. </p>
<dl class="section note"><dt>Note</dt><dd>This defines the database format of a NodeObject! </dd></dl>
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00034">34</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1b3f76ab2c8935a08fb71f77e2100ba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b3f76ab2c8935a08fb71f77e2100ba4">&#9670;&nbsp;</a></span>prepare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::NodeStore::EncodedBlob::prepare </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8cpp_source.html#l00027">27</a> of file <a class="el" href="EncodedBlob_8cpp_source.html">EncodedBlob.cpp</a>.</p>
</div>
</div>
<a id="a5e302b42921788cc860be6e51f759d76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e302b42921788cc860be6e51f759d76">&#9670;&nbsp;</a></span>getKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void const* ripple::NodeStore::EncodedBlob::getKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00041">41</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div>
</div>
<a id="a709e5c71eeb5b9a9eb635b9c02143815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a709e5c71eeb5b9a9eb635b9c02143815">&#9670;&nbsp;</a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::NodeStore::EncodedBlob::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00047">47</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div>
</div>
<a id="af168e5bddf805f34c09e254d1b078bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af168e5bddf805f34c09e254d1b078bfa">&#9670;&nbsp;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void const* ripple::NodeStore::EncodedBlob::getData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00053">53</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adcf74402099226d78d3a94e92ccac80d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcf74402099226d78d3a94e92ccac80d">&#9670;&nbsp;</a></span>m_key</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void const* ripple::NodeStore::EncodedBlob::m_key</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00059">59</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div>
</div>
<a id="aa6af4ac37c23417a3fc82359fd0f71ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6af4ac37c23417a3fc82359fd0f71ba">&#9670;&nbsp;</a></span>m_data</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Buffer.html">Buffer</a> ripple::NodeStore::EncodedBlob::m_data</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="EncodedBlob_8h_source.html#l00060">60</a> of file <a class="el" href="EncodedBlob_8h_source.html">EncodedBlob.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink