ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 020b285808

Browse Source
This commit is contained in:
nbougalis
2020-04-15 21:15:02 +00:00
commit 4ad595bf18
12373 changed files with 1478990 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
Store_8h_source.html Normal file
View File

@@ -0,0 +1,142 @@
<!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: Store.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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_44aff85a5b558cac9311bb222eb8fa78.html">peerfinder</a></li><li class="navelem"><a class="el" href="dir_01f812eedbcff88039c2ca147e9e73a6.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Store.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_PEERFINDER_STORE_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_PEERFINDER_STORE_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<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>&#160;<span class="keyword">namespace </span>PeerFinder {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1PeerFinder_1_1Store.html">Store</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#aae1ef0969af29739fcd719ca3c5f03f0"> 30</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classripple_1_1PeerFinder_1_1Store.html#aae1ef0969af29739fcd719ca3c5f03f0">~Store</a> () { }</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// load the bootstrap cache</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#a9b34c3afd94f0beb02edc9d9e127a4c1"> 33</a></span>&#160; <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">load_callback</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a> &lt;void (<a class="code" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a>, <span class="keywordtype">int</span>)&gt;;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code" href="classripple_1_1PeerFinder_1_1Store.html#ac7438695b75741d34718790f810a6430">load</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">load_callback</a> <span class="keyword">const</span>&amp; cb) = 0;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// save the bootstrap cache</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html"> 37</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html">Entry</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">explicit</span> <a class="code" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a883a09559a3eaa5e5c4c4205b2d1e6e0">Entry</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a3c12d19b9928e63e60a5c46b70509838"> 41</a></span>&#160; <a class="code" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <a class="code" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a3c12d19b9928e63e60a5c46b70509838">endpoint</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3"> 42</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3">valence</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; };</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classripple_1_1PeerFinder_1_1Store.html#a33cce5a12406efe8d4c22e564060ea03">save</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector &lt;Entry&gt;</a> <span class="keyword">const</span>&amp; v) = 0;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;};</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Store_1_1Entry_html_a883a09559a3eaa5e5c4c4205b2d1e6e0"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a883a09559a3eaa5e5c4c4205b2d1e6e0">ripple::PeerFinder::Store::Entry::Entry</a></div><div class="ttdeci">Entry()=default</div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Store_html"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Store.html">ripple::PeerFinder::Store</a></div><div class="ttdoc">Abstract persistence for PeerFinder data.</div><div class="ttdef"><b>Definition:</b> <a href="Store_8h_source.html#l00027">Store.h:27</a></div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Store_1_1Entry_html_a655fa5ae18ff218993a606634f07f3e3"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3">ripple::PeerFinder::Store::Entry::valence</a></div><div class="ttdeci">int valence</div><div class="ttdef"><b>Definition:</b> <a href="Store_8h_source.html#l00042">Store.h:42</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Store_html_a33cce5a12406efe8d4c22e564060ea03"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Store.html#a33cce5a12406efe8d4c22e564060ea03">ripple::PeerFinder::Store::save</a></div><div class="ttdeci">virtual void save(std::vector&lt; Entry &gt; const &amp;v)=0</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="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="aclassbeast_1_1IP_1_1Endpoint_html"><div class="ttname"><a href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a></div><div class="ttdoc">A version-independent IP address and port combination.</div><div class="ttdef"><b>Definition:</b> <a href="IPEndpoint_8h_source.html#l00039">IPEndpoint.h:39</a></div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Store_1_1Entry_html"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html">ripple::PeerFinder::Store::Entry</a></div><div class="ttdef"><b>Definition:</b> <a href="Store_8h_source.html#l00037">Store.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Store_html_ac7438695b75741d34718790f810a6430"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Store.html#ac7438695b75741d34718790f810a6430">ripple::PeerFinder::Store::load</a></div><div class="ttdeci">virtual std::size_t load(load_callback const &amp;cb)=0</div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Store_1_1Entry_html_a3c12d19b9928e63e60a5c46b70509838"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a3c12d19b9928e63e60a5c46b70509838">ripple::PeerFinder::Store::Entry::endpoint</a></div><div class="ttdeci">beast::IP::Endpoint endpoint</div><div class="ttdef"><b>Definition:</b> <a href="Store_8h_source.html#l00041">Store.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Store_html_aae1ef0969af29739fcd719ca3c5f03f0"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Store.html#aae1ef0969af29739fcd719ca3c5f03f0">ripple::PeerFinder::Store::~Store</a></div><div class="ttdeci">virtual ~Store()</div><div class="ttdef"><b>Definition:</b> <a href="Store_8h_source.html#l00030">Store.h:30</a></div></div>
<!-- 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>