Files
rippled/src_2xrpld_2overlay_2detail_2Tuning_8h_source.html
2025-11-04 00:36:48 -08:00

145 lines
18 KiB
HTML

<!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: Tuning.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_c4f38cd849aa2a8e7280b7c5f705957a.html">overlay</a></li><li class="navelem"><a class="el" href="dir_a79f2d25ef1e73674b335287bd5311a8.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">src/xrpld/overlay/detail/Tuning.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_OVERLAY_TUNING_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_OVERLAY_TUNING_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;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/chrono.html">chrono</a>&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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</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="namespaceripple_1_1Tuning.html"> 8</a></span><span class="keyword">namespace </span>Tuning {</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">enum</span> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa991f7034b02d9b550b1c64a597c0faaf"> 13</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa991f7034b02d9b550b1c64a597c0faaf">convergedLedgerLimit</a> = 24,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac19611797683cae3c0d7e80c69508d6d"> 17</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac19611797683cae3c0d7e80c69508d6d">divergedLedgerLimit</a> = 128,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa156b806f3cd8e506444feda0328169c4"> 20</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa156b806f3cd8e506444feda0328169c4">softMaxReplyNodes</a> = 8192,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa57fbf7bb7fb66538d27bb5e802adda33"> 23</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa57fbf7bb7fb66538d27bb5e802adda33">hardMaxReplyNodes</a> = 12288,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aab1675121c898e98033db8e9111642e6f"> 27</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aab1675121c898e98033db8e9111642e6f">sendqIntervals</a> = 4,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac53e07d6dbec8160ba8b4631a39fe84f"> 30</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac53e07d6dbec8160ba8b4631a39fe84f">dropSendQueue</a> = 192,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa18c2b9f69bcc5e76875aa02bfb0908ec"> 33</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa18c2b9f69bcc5e76875aa02bfb0908ec">targetSendQueue</a> = 128,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aabdc936f3cecce920c48b176c0f8bc0a7"> 36</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aabdc936f3cecce920c48b176c0f8bc0a7">sendQueueLogFreq</a> = 64,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa253dac09e40a5b8076dc4ea672e6aba7"> 39</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa253dac09e40a5b8076dc4ea672e6aba7">checkIdlePeers</a> = 4,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa5560358d1654b8d46cd3728b4aba826c"> 42</a></span> <a class="code hl_enumvalue" href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa5560358d1654b8d46cd3728b4aba826c">maxQueryDepth</a> = 3,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>};</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a1c40293747af149dcbcc99e5b1d8d286"> 46</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple_1_1Tuning.html#a1c40293747af149dcbcc99e5b1d8d286">readBufferBytes</a> = 16384;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>} <span class="comment">// namespace Tuning</span></div>
</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="comment">// namespace ripple</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="achrono_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/chrono.html">chrono</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a1c40293747af149dcbcc99e5b1d8d286"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a1c40293747af149dcbcc99e5b1d8d286">ripple::Tuning::readBufferBytes</a></div><div class="ttdeci">std::size_t constexpr readBufferBytes</div><div class="ttdoc">Size of buffer used to read from the socket.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00046">src/xrpld/overlay/detail/Tuning.h:46</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa156b806f3cd8e506444feda0328169c4"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa156b806f3cd8e506444feda0328169c4">ripple::Tuning::softMaxReplyNodes</a></div><div class="ttdeci">@ softMaxReplyNodes</div><div class="ttdoc">The soft cap on the number of ledger entries in a single reply.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00020">src/xrpld/overlay/detail/Tuning.h:20</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa18c2b9f69bcc5e76875aa02bfb0908ec"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa18c2b9f69bcc5e76875aa02bfb0908ec">ripple::Tuning::targetSendQueue</a></div><div class="ttdeci">@ targetSendQueue</div><div class="ttdoc">How many messages we consider reasonable sustained on a send queue.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00033">src/xrpld/overlay/detail/Tuning.h:33</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa253dac09e40a5b8076dc4ea672e6aba7"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa253dac09e40a5b8076dc4ea672e6aba7">ripple::Tuning::checkIdlePeers</a></div><div class="ttdeci">@ checkIdlePeers</div><div class="ttdoc">How often we check for idle peers (seconds)</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00039">src/xrpld/overlay/detail/Tuning.h:39</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa5560358d1654b8d46cd3728b4aba826c"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa5560358d1654b8d46cd3728b4aba826c">ripple::Tuning::maxQueryDepth</a></div><div class="ttdeci">@ maxQueryDepth</div><div class="ttdoc">The maximum number of levels to search.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00042">src/xrpld/overlay/detail/Tuning.h:42</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa57fbf7bb7fb66538d27bb5e802adda33"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa57fbf7bb7fb66538d27bb5e802adda33">ripple::Tuning::hardMaxReplyNodes</a></div><div class="ttdeci">@ hardMaxReplyNodes</div><div class="ttdoc">The hard cap on the number of ledger entries in a single reply.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00023">src/xrpld/overlay/detail/Tuning.h:23</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aa991f7034b02d9b550b1c64a597c0faaf"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aa991f7034b02d9b550b1c64a597c0faaf">ripple::Tuning::convergedLedgerLimit</a></div><div class="ttdeci">@ convergedLedgerLimit</div><div class="ttdoc">How many ledgers off a server can be and we will still consider it converged.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00013">src/xrpld/overlay/detail/Tuning.h:13</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aab1675121c898e98033db8e9111642e6f"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aab1675121c898e98033db8e9111642e6f">ripple::Tuning::sendqIntervals</a></div><div class="ttdeci">@ sendqIntervals</div><div class="ttdoc">How many timer intervals a sendq has to stay large before we disconnect.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00027">src/xrpld/overlay/detail/Tuning.h:27</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aabdc936f3cecce920c48b176c0f8bc0a7"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aabdc936f3cecce920c48b176c0f8bc0a7">ripple::Tuning::sendQueueLogFreq</a></div><div class="ttdeci">@ sendQueueLogFreq</div><div class="ttdoc">How often to log send queue size.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00036">src/xrpld/overlay/detail/Tuning.h:36</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aac19611797683cae3c0d7e80c69508d6d"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac19611797683cae3c0d7e80c69508d6d">ripple::Tuning::divergedLedgerLimit</a></div><div class="ttdeci">@ divergedLedgerLimit</div><div class="ttdoc">How many ledgers off a server has to be before we consider it diverged.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00017">src/xrpld/overlay/detail/Tuning.h:17</a></div></div>
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a4170faee805153770be2a0fe3275812aac53e07d6dbec8160ba8b4631a39fe84f"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a4170faee805153770be2a0fe3275812aac53e07d6dbec8160ba8b4631a39fe84f">ripple::Tuning::dropSendQueue</a></div><div class="ttdeci">@ dropSendQueue</div><div class="ttdoc">How many messages on a send queue before we refuse queries.</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2overlay_2detail_2Tuning_8h_source.html#l00030">src/xrpld/overlay/detail/Tuning.h:30</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><!-- 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>