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

528 lines
31 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: ripple::PeerFinder::Config 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 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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1PeerFinder.html">PeerFinder</a></li><li class="navelem"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structripple_1_1PeerFinder_1_1Config-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::PeerFinder::Config Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="namespaceripple_1_1PeerFinder.html">PeerFinder</a> configuration settings.
<a href="structripple_1_1PeerFinder_1_1Config.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::PeerFinder::Config:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1PeerFinder_1_1Config__coll__graph.png" border="0" usemap="#aripple_1_1PeerFinder_1_1Config_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1PeerFinder_1_1Config_coll__map" id="aripple_1_1PeerFinder_1_1Config_coll__map">
<area shape="rect" title="PeerFinder configuration settings." alt="" coords="101,212,237,252"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="5,95,93,120"/>
<area shape="poly" title=" " alt="" coords="63,131,79,159,101,186,133,210,129,214,97,190,74,162,58,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="118,95,221,120"/>
<area shape="poly" title=" " alt="" coords="172,134,172,212,167,212,167,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="245,95,331,120"/>
<area shape="poly" title=" " alt="" coords="286,135,276,163,259,190,244,203,226,214,223,210,240,199,255,186,272,160,281,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="219,5,357,45"/>
<area shape="poly" title=" " alt="" coords="291,59,291,94,285,94,285,59"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a189d9cacf39182df611c2e0ba2dd177f" id="r_a189d9cacf39182df611c2e0ba2dd177f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a189d9cacf39182df611c2e0ba2dd177f">Config</a> ()</td></tr>
<tr class="memdesc:a189d9cacf39182df611c2e0ba2dd177f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a configuration with default values. <br /></td></tr>
<tr class="separator:a189d9cacf39182df611c2e0ba2dd177f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af22578657f9b42b4c0b66cb6289761aa" id="r_af22578657f9b42b4c0b66cb6289761aa"><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_1PeerFinder_1_1Config.html#af22578657f9b42b4c0b66cb6289761aa">calcOutPeers</a> () const</td></tr>
<tr class="memdesc:af22578657f9b42b4c0b66cb6289761aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a suitable value for outPeers according to the rules. <br /></td></tr>
<tr class="separator:af22578657f9b42b4c0b66cb6289761aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fde17254835e48c5b090bb00fe337e9" id="r_a7fde17254835e48c5b090bb00fe337e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a7fde17254835e48c5b090bb00fe337e9">applyTuning</a> ()</td></tr>
<tr class="memdesc:a7fde17254835e48c5b090bb00fe337e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts the values so they follow the business rules. <br /></td></tr>
<tr class="separator:a7fde17254835e48c5b090bb00fe337e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0003a9384327d7c4a4823fa736bf86cc" id="r_a0003a9384327d7c4a4823fa736bf86cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a0003a9384327d7c4a4823fa736bf86cc">onWrite</a> (<a class="el" href="classbeast_1_1PropertyStream_1_1Map.html">beast::PropertyStream::Map</a> &amp;map)</td></tr>
<tr class="memdesc:a0003a9384327d7c4a4823fa736bf86cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the configuration into a property stream. <br /></td></tr>
<tr class="separator:a0003a9384327d7c4a4823fa736bf86cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9321a565c8d2fac0bbc77cb24582fc94" id="r_a9321a565c8d2fac0bbc77cb24582fc94"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a9321a565c8d2fac0bbc77cb24582fc94">makeConfig</a> (<a class="el" href="classripple_1_1Config.html">ripple::Config</a> const &amp;config, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> port, bool validationPublicKey, int <a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a46decaaf39a6782668b563d2d774ddb5">ipLimit</a>)</td></tr>
<tr class="memdesc:a9321a565c8d2fac0bbc77cb24582fc94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="structripple_1_1PeerFinder_1_1Config.html" title="PeerFinder configuration settings.">PeerFinder::Config</a> from configuration parameters. <br /></td></tr>
<tr class="separator:a9321a565c8d2fac0bbc77cb24582fc94"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa0026277cfc4914ecc8d136e5a94ef8e" id="r_aa0026277cfc4914ecc8d136e5a94ef8e"><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_1PeerFinder_1_1Config.html#aa0026277cfc4914ecc8d136e5a94ef8e">maxPeers</a></td></tr>
<tr class="memdesc:aa0026277cfc4914ecc8d136e5a94ef8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The largest number of public peer slots to allow. <br /></td></tr>
<tr class="separator:aa0026277cfc4914ecc8d136e5a94ef8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a20f47b40f06984c08aed2ca613613" id="r_ab9a20f47b40f06984c08aed2ca613613"><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_1PeerFinder_1_1Config.html#ab9a20f47b40f06984c08aed2ca613613">outPeers</a></td></tr>
<tr class="memdesc:ab9a20f47b40f06984c08aed2ca613613"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of automatic outbound connections to maintain. <br /></td></tr>
<tr class="separator:ab9a20f47b40f06984c08aed2ca613613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c60a2f6d0ef7a67fc7144f09f57d04" id="r_a67c60a2f6d0ef7a67fc7144f09f57d04"><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_1PeerFinder_1_1Config.html#a67c60a2f6d0ef7a67fc7144f09f57d04">inPeers</a></td></tr>
<tr class="memdesc:a67c60a2f6d0ef7a67fc7144f09f57d04"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of automatic inbound connections to maintain. <br /></td></tr>
<tr class="separator:a67c60a2f6d0ef7a67fc7144f09f57d04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b3a48e05361caa57d3e0c09e37a166" id="r_af9b3a48e05361caa57d3e0c09e37a166"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#af9b3a48e05361caa57d3e0c09e37a166">peerPrivate</a> = true</td></tr>
<tr class="memdesc:af9b3a48e05361caa57d3e0c09e37a166"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>true</code> if we want our IP address kept private. <br /></td></tr>
<tr class="separator:af9b3a48e05361caa57d3e0c09e37a166"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab92a8f8d998ed8d7e2940b71734fa09f" id="r_ab92a8f8d998ed8d7e2940b71734fa09f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#ab92a8f8d998ed8d7e2940b71734fa09f">wantIncoming</a></td></tr>
<tr class="memdesc:ab92a8f8d998ed8d7e2940b71734fa09f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>true</code> if we want to accept incoming connections. <br /></td></tr>
<tr class="separator:ab92a8f8d998ed8d7e2940b71734fa09f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aa0119410e7741efd384492c1e5a3b9" id="r_a2aa0119410e7741efd384492c1e5a3b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a2aa0119410e7741efd384492c1e5a3b9">autoConnect</a></td></tr>
<tr class="memdesc:a2aa0119410e7741efd384492c1e5a3b9"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>true</code> if we want to establish connections automatically <br /></td></tr>
<tr class="separator:a2aa0119410e7741efd384492c1e5a3b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8629cfefba4fb74f5a498562eddc06b" id="r_af8629cfefba4fb74f5a498562eddc06b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#af8629cfefba4fb74f5a498562eddc06b">listeningPort</a></td></tr>
<tr class="memdesc:af8629cfefba4fb74f5a498562eddc06b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The listening port number. <br /></td></tr>
<tr class="separator:af8629cfefba4fb74f5a498562eddc06b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5462b5e4ecc5a63168673fcf64ed221" id="r_ab5462b5e4ecc5a63168673fcf64ed221"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#ab5462b5e4ecc5a63168673fcf64ed221">features</a></td></tr>
<tr class="memdesc:ab5462b5e4ecc5a63168673fcf64ed221"><td class="mdescLeft">&#160;</td><td class="mdescRight">The set of features we advertise. <br /></td></tr>
<tr class="separator:ab5462b5e4ecc5a63168673fcf64ed221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46decaaf39a6782668b563d2d774ddb5" id="r_a46decaaf39a6782668b563d2d774ddb5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#a46decaaf39a6782668b563d2d774ddb5">ipLimit</a></td></tr>
<tr class="memdesc:a46decaaf39a6782668b563d2d774ddb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Limit how many incoming connections we allow per IP. <br /></td></tr>
<tr class="separator:a46decaaf39a6782668b563d2d774ddb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:afb682cfc22bdb3d6e89c7c1b2e2b514a" id="r_afb682cfc22bdb3d6e89c7c1b2e2b514a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html#afb682cfc22bdb3d6e89c7c1b2e2b514a">operator==</a> (<a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a> const &amp;lhs, <a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a> const &amp;rhs)</td></tr>
<tr class="separator:afb682cfc22bdb3d6e89c7c1b2e2b514a"><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><a class="el" href="namespaceripple_1_1PeerFinder.html">PeerFinder</a> configuration settings. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00025">25</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a189d9cacf39182df611c2e0ba2dd177f" name="a189d9cacf39182df611c2e0ba2dd177f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a189d9cacf39182df611c2e0ba2dd177f">&#9670;&#160;</a></span>Config()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::PeerFinder::Config::Config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a configuration with default values. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00007">7</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af22578657f9b42b4c0b66cb6289761aa" name="af22578657f9b42b4c0b66cb6289761aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af22578657f9b42b4c0b66cb6289761aa">&#9670;&#160;</a></span>calcOutPeers()</h2>
<div class="memitem">
<div class="memproto">
<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::PeerFinder::Config::calcOutPeers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a suitable value for outPeers according to the rules. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00030">30</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<a id="a7fde17254835e48c5b090bb00fe337e9" name="a7fde17254835e48c5b090bb00fe337e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fde17254835e48c5b090bb00fe337e9">&#9670;&#160;</a></span>applyTuning()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::PeerFinder::Config::applyTuning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adjusts the values so they follow the business rules. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00038">38</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<a id="a0003a9384327d7c4a4823fa736bf86cc" name="a0003a9384327d7c4a4823fa736bf86cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0003a9384327d7c4a4823fa736bf86cc">&#9670;&#160;</a></span>onWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::PeerFinder::Config::onWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1PropertyStream_1_1Map.html">beast::PropertyStream::Map</a> &amp;&#160;</td>
<td class="paramname"><em>map</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the configuration into a property stream. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00058">58</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<a id="a9321a565c8d2fac0bbc77cb24582fc94" name="a9321a565c8d2fac0bbc77cb24582fc94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9321a565c8d2fac0bbc77cb24582fc94">&#9670;&#160;</a></span>makeConfig()</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="structripple_1_1PeerFinder_1_1Config.html">Config</a> ripple::PeerFinder::Config::makeConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">ripple::Config</a> const &amp;&#160;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>validationPublicKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>ipLimit</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Make <a class="el" href="structripple_1_1PeerFinder_1_1Config.html" title="PeerFinder configuration settings.">PeerFinder::Config</a> from configuration parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>server's configuration </td></tr>
<tr><td class="paramname">port</td><td>server's listening port </td></tr>
<tr><td class="paramname">validationPublicKey</td><td>true if validation public key is not empty </td></tr>
<tr><td class="paramname">ipLimit</td><td>limit of incoming connections per IP </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structripple_1_1PeerFinder_1_1Config.html" title="PeerFinder configuration settings.">PeerFinder::Config</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00070">70</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="afb682cfc22bdb3d6e89c7c1b2e2b514a" name="afb682cfc22bdb3d6e89c7c1b2e2b514a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb682cfc22bdb3d6e89c7c1b2e2b514a">&#9670;&#160;</a></span>operator==</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a> const &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1PeerFinder_1_1Config.html">Config</a> const &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PeerfinderConfig_8cpp_source.html#l00019">19</a> of file <a class="el" href="PeerfinderConfig_8cpp_source.html">PeerfinderConfig.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa0026277cfc4914ecc8d136e5a94ef8e" name="aa0026277cfc4914ecc8d136e5a94ef8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0026277cfc4914ecc8d136e5a94ef8e">&#9670;&#160;</a></span>maxPeers</h2>
<div class="memitem">
<div class="memproto">
<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::PeerFinder::Config::maxPeers</td>
</tr>
</table>
</div><div class="memdoc">
<p>The largest number of public peer slots to allow. </p>
<p>This includes both inbound and outbound, but does not include fixed peers. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00031">31</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="ab9a20f47b40f06984c08aed2ca613613" name="ab9a20f47b40f06984c08aed2ca613613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9a20f47b40f06984c08aed2ca613613">&#9670;&#160;</a></span>outPeers</h2>
<div class="memitem">
<div class="memproto">
<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::PeerFinder::Config::outPeers</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of automatic outbound connections to maintain. </p>
<p>Outbound connections are only maintained if autoConnect is <code>true</code>. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00037">37</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="a67c60a2f6d0ef7a67fc7144f09f57d04" name="a67c60a2f6d0ef7a67fc7144f09f57d04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c60a2f6d0ef7a67fc7144f09f57d04">&#9670;&#160;</a></span>inPeers</h2>
<div class="memitem">
<div class="memproto">
<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::PeerFinder::Config::inPeers</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of automatic inbound connections to maintain. </p>
<p>Inbound connections are only maintained if wantIncoming is <code>true</code>. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00043">43</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="af9b3a48e05361caa57d3e0c09e37a166" name="af9b3a48e05361caa57d3e0c09e37a166"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9b3a48e05361caa57d3e0c09e37a166">&#9670;&#160;</a></span>peerPrivate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::PeerFinder::Config::peerPrivate = true</td>
</tr>
</table>
</div><div class="memdoc">
<p><code>true</code> if we want our IP address kept private. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00046">46</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="ab92a8f8d998ed8d7e2940b71734fa09f" name="ab92a8f8d998ed8d7e2940b71734fa09f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab92a8f8d998ed8d7e2940b71734fa09f">&#9670;&#160;</a></span>wantIncoming</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::PeerFinder::Config::wantIncoming</td>
</tr>
</table>
</div><div class="memdoc">
<p><code>true</code> if we want to accept incoming connections. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00049">49</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="a2aa0119410e7741efd384492c1e5a3b9" name="a2aa0119410e7741efd384492c1e5a3b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2aa0119410e7741efd384492c1e5a3b9">&#9670;&#160;</a></span>autoConnect</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::PeerFinder::Config::autoConnect</td>
</tr>
</table>
</div><div class="memdoc">
<p><code>true</code> if we want to establish connections automatically </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00052">52</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="af8629cfefba4fb74f5a498562eddc06b" name="af8629cfefba4fb74f5a498562eddc06b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8629cfefba4fb74f5a498562eddc06b">&#9670;&#160;</a></span>listeningPort</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> ripple::PeerFinder::Config::listeningPort</td>
</tr>
</table>
</div><div class="memdoc">
<p>The listening port number. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00055">55</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="ab5462b5e4ecc5a63168673fcf64ed221" name="ab5462b5e4ecc5a63168673fcf64ed221"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5462b5e4ecc5a63168673fcf64ed221">&#9670;&#160;</a></span>features</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::PeerFinder::Config::features</td>
</tr>
</table>
</div><div class="memdoc">
<p>The set of features we advertise. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00058">58</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
<a id="a46decaaf39a6782668b563d2d774ddb5" name="a46decaaf39a6782668b563d2d774ddb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46decaaf39a6782668b563d2d774ddb5">&#9670;&#160;</a></span>ipLimit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::PeerFinder::Config::ipLimit</td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit how many incoming connections we allow per IP. </p>
<p class="definition">Definition at line <a class="el" href="PeerfinderManager_8h_source.html#l00061">61</a> of file <a class="el" href="PeerfinderManager_8h_source.html">PeerfinderManager.h</a>.</p>
</div>
</div>
</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