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

153 lines
15 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: Source.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">Source.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_SOURCE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PEERFINDER_SOURCE_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="preprocessor">#include &lt;xrpld/peerfinder/PeerfinderManager.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;boost/system/error_code.hpp&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>PeerFinder {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Source.html"> 19</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1PeerFinder_1_1Source.html">Source</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html"> 23</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html">Results</a></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_1Source_1_1Results.html#a8e657e9bf1a724ce6d4dc0e3f2c83bff"> 25</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a8e657e9bf1a724ce6d4dc0e3f2c83bff">Results</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// error_code on a failure</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a4f39eebc12a1fb262f9b3fc302b17fb0"> 28</a></span> boost::system::error_code <a class="code hl_variable" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a4f39eebc12a1fb262f9b3fc302b17fb0">error</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// list of fetched endpoints</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a9e0993e3e96f4aac943da6957c427007"> 31</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">IPAddresses</a> <a class="code hl_variable" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a9e0993e3e96f4aac943da6957c427007">addresses</a>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> };</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Source.html#a4a860c3d0fb6cfeb52a77091362cdc53"> 34</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Source.html#a4a860c3d0fb6cfeb52a77091362cdc53">~Source</a>()</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Source.html#a6247bd10f96c51b7b9f566ab7cb7033d"> 38</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Source.html#a6247bd10f96c51b7b9f566ab7cb7033d">name</a>() = 0;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Source.html#a94789f59b098d37b35bf8d9b9dcdb46f"> 40</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Source.html#a94789f59b098d37b35bf8d9b9dcdb46f">cancel</a>()</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Source.html#a915205fd6d8a3e16d25b7012e02431fb"> 44</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Source.html#a915205fd6d8a3e16d25b7012e02431fb">fetch</a>(<a class="code hl_struct" href="structripple_1_1PeerFinder_1_1Source_1_1Results.html">Results</a>&amp; results, <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal) = 0;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>};</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>} <span class="comment">// namespace PeerFinder</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Source_html"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Source.html">ripple::PeerFinder::Source</a></div><div class="ttdoc">A static or dynamic source of peer addresses.</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00019">Source.h:20</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Source_html_a4a860c3d0fb6cfeb52a77091362cdc53"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Source.html#a4a860c3d0fb6cfeb52a77091362cdc53">ripple::PeerFinder::Source::~Source</a></div><div class="ttdeci">virtual ~Source()</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00034">Source.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Source_html_a6247bd10f96c51b7b9f566ab7cb7033d"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Source.html#a6247bd10f96c51b7b9f566ab7cb7033d">ripple::PeerFinder::Source::name</a></div><div class="ttdeci">virtual std::string const &amp; name()=0</div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Source_html_a915205fd6d8a3e16d25b7012e02431fb"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Source.html#a915205fd6d8a3e16d25b7012e02431fb">ripple::PeerFinder::Source::fetch</a></div><div class="ttdeci">virtual void fetch(Results &amp;results, beast::Journal journal)=0</div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Source_html_a94789f59b098d37b35bf8d9b9dcdb46f"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Source.html#a94789f59b098d37b35bf8d9b9dcdb46f">ripple::PeerFinder::Source::cancel</a></div><div class="ttdeci">virtual void cancel()</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00040">Source.h:40</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="astructripple_1_1PeerFinder_1_1Source_1_1Results_html"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Source_1_1Results.html">ripple::PeerFinder::Source::Results</a></div><div class="ttdoc">The results of a fetch.</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00023">Source.h:24</a></div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Source_1_1Results_html_a4f39eebc12a1fb262f9b3fc302b17fb0"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a4f39eebc12a1fb262f9b3fc302b17fb0">ripple::PeerFinder::Source::Results::error</a></div><div class="ttdeci">boost::system::error_code error</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00028">Source.h:28</a></div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Source_1_1Results_html_a8e657e9bf1a724ce6d4dc0e3f2c83bff"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a8e657e9bf1a724ce6d4dc0e3f2c83bff">ripple::PeerFinder::Source::Results::Results</a></div><div class="ttdeci">Results()=default</div></div>
<div class="ttc" id="astructripple_1_1PeerFinder_1_1Source_1_1Results_html_a9e0993e3e96f4aac943da6957c427007"><div class="ttname"><a href="structripple_1_1PeerFinder_1_1Source_1_1Results.html#a9e0993e3e96f4aac943da6957c427007">ripple::PeerFinder::Source::Results::addresses</a></div><div class="ttdeci">IPAddresses addresses</div><div class="ttdef"><b>Definition</b> <a href="Source_8h_source.html#l00031">Source.h:31</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&lt; beast::IP::Endpoint &gt;</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