ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 19:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/Store_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

144 lines
14 KiB
HTML
Raw Permalink 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.8"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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_89046728185f0c274a4164d3e2cb38fb.html">peerfinder</a></li><li class="navelem"><a class="el" href="dir_e9607b4c59cebecf2224e361d8d6d362.html">detail</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_PEERFINDER_STORE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PEERFINDER_STORE_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span>PeerFinder {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="};">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html"> 8</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1PeerFinder_1_1Store.html">Store</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="}">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#aae1ef0969af29739fcd719ca3c5f03f0"> 11</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Store.html#aae1ef0969af29739fcd719ca3c5f03f0">~Store</a>()</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> }</div>
</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// load the bootstrap cache</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#a6b8f732ded7d37a870b6e5555d215b90"> 16</a></span> <span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">load_callback</a> = <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void(<a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a>, <span class="keywordtype">int</span>)&gt;;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#ac7438695b75741d34718790f810a6430"> 18</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Store.html#ac7438695b75741d34718790f810a6430">load</a>(<a class="code hl_classRef" 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 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="comment">// save the bootstrap cache</span></div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html"> 21</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html">Entry</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a883a09559a3eaa5e5c4c4205b2d1e6e0"> 23</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a883a09559a3eaa5e5c4c4205b2d1e6e0">Entry</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a3c12d19b9928e63e60a5c46b70509838"> 25</a></span> <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <a class="code hl_variable" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a3c12d19b9928e63e60a5c46b70509838">endpoint</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3"> 26</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3">valence</a>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> };</div>
</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Store.html#a33cce5a12406efe8d4c22e564060ea03"> 29</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Store.html#a33cce5a12406efe8d4c22e564060ea03">save</a>(<a class="code hl_classRef" 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 id="l00030" name="l00030"></a><span class="lineno"> 30</span>};</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>} <span class="comment">// namespace PeerFinder</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>} <span class="comment">// namespace ripple</span></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><span class="preprocessor">#endif</span></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#l00018">IPEndpoint.h:19</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#l00008">Store.h:9</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="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#l00011">Store.h:11</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="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="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#l00006">algorithm.h:6</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="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#l00021">Store.h:22</a></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#l00025">Store.h:25</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#l00026">Store.h:26</a></div></div>
<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>
</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink