mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
152 lines
20 KiB
HTML
152 lines
20 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">
|
|
<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: 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 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&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&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_b003f5a72efe503c7552f86021e0c4d2.html">overlay</a></li><li class="navelem"><a class="el" href="dir_3d31096116cb07f2d03f31d101bf2478.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">overlay/impl/Tuning.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <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> <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> <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> <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> <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> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_OVERLAY_TUNING_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_OVERLAY_TUNING_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/chrono.html">chrono</a>></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html"> 27</a></span> <span class="keyword">namespace </span>Tuning {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a991f7034b02d9b550b1c64a597c0faaf"> 32</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a991f7034b02d9b550b1c64a597c0faaf">convergedLedgerLimit</a> = 24,</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac19611797683cae3c0d7e80c69508d6d"> 36</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac19611797683cae3c0d7e80c69508d6d">divergedLedgerLimit</a> = 128,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a156b806f3cd8e506444feda0328169c4"> 39</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a156b806f3cd8e506444feda0328169c4">softMaxReplyNodes</a> = 8192,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a57fbf7bb7fb66538d27bb5e802adda33"> 42</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a57fbf7bb7fb66538d27bb5e802adda33">hardMaxReplyNodes</a> = 12288,</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ab1675121c898e98033db8e9111642e6f"> 46</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ab1675121c898e98033db8e9111642e6f">sendqIntervals</a> = 4,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac53e07d6dbec8160ba8b4631a39fe84f"> 49</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac53e07d6dbec8160ba8b4631a39fe84f">dropSendQueue</a> = 192,</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a18c2b9f69bcc5e76875aa02bfb0908ec"> 52</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a18c2b9f69bcc5e76875aa02bfb0908ec">targetSendQueue</a> = 128,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10abdc936f3cecce920c48b176c0f8bc0a7"> 55</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10abdc936f3cecce920c48b176c0f8bc0a7">sendQueueLogFreq</a> = 64,</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a253dac09e40a5b8076dc4ea672e6aba7"> 58</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a253dac09e40a5b8076dc4ea672e6aba7">checkIdlePeers</a> = 4,</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a5560358d1654b8d46cd3728b4aba826c"> 61</a></span>  <a class="code" href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a5560358d1654b8d46cd3728b4aba826c">maxQueryDepth</a> = 3,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="namespaceripple_1_1Tuning.html#a6ea075928ccbe3bf56b2790975b9d8d1"> 65</a></span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> constexpr <a class="code" href="namespaceripple_1_1Tuning.html#a6ea075928ccbe3bf56b2790975b9d8d1">readBufferBytes</a> = 16384;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">// namespace Tuning</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10a253dac09e40a5b8076dc4ea672e6aba7"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a253dac09e40a5b8076dc4ea672e6aba7">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="overlay_2impl_2Tuning_8h_source.html#l00058">overlay/impl/Tuning.h:58</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10a156b806f3cd8e506444feda0328169c4"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a156b806f3cd8e506444feda0328169c4">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="overlay_2impl_2Tuning_8h_source.html#l00039">overlay/impl/Tuning.h:39</a></div></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_a728589bd52b8426227390d5640782a10a57fbf7bb7fb66538d27bb5e802adda33"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a57fbf7bb7fb66538d27bb5e802adda33">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="overlay_2impl_2Tuning_8h_source.html#l00042">overlay/impl/Tuning.h:42</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10a991f7034b02d9b550b1c64a597c0faaf"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a991f7034b02d9b550b1c64a597c0faaf">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="overlay_2impl_2Tuning_8h_source.html#l00032">overlay/impl/Tuning.h:32</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10ac53e07d6dbec8160ba8b4631a39fe84f"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac53e07d6dbec8160ba8b4631a39fe84f">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="overlay_2impl_2Tuning_8h_source.html#l00049">overlay/impl/Tuning.h:49</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10ac19611797683cae3c0d7e80c69508d6d"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ac19611797683cae3c0d7e80c69508d6d">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="overlay_2impl_2Tuning_8h_source.html#l00036">overlay/impl/Tuning.h:36</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a6ea075928ccbe3bf56b2790975b9d8d1"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a6ea075928ccbe3bf56b2790975b9d8d1">ripple::Tuning::readBufferBytes</a></div><div class="ttdeci">constexpr std::size_t readBufferBytes</div><div class="ttdoc">Size of buffer used to read from the socket.</div><div class="ttdef"><b>Definition:</b> <a href="overlay_2impl_2Tuning_8h_source.html#l00065">overlay/impl/Tuning.h:65</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10a18c2b9f69bcc5e76875aa02bfb0908ec"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a18c2b9f69bcc5e76875aa02bfb0908ec">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="overlay_2impl_2Tuning_8h_source.html#l00052">overlay/impl/Tuning.h:52</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="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10ab1675121c898e98033db8e9111642e6f"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10ab1675121c898e98033db8e9111642e6f">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="overlay_2impl_2Tuning_8h_source.html#l00046">overlay/impl/Tuning.h:46</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10abdc936f3cecce920c48b176c0f8bc0a7"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10abdc936f3cecce920c48b176c0f8bc0a7">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="overlay_2impl_2Tuning_8h_source.html#l00055">overlay/impl/Tuning.h:55</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Tuning_html_a728589bd52b8426227390d5640782a10a5560358d1654b8d46cd3728b4aba826c"><div class="ttname"><a href="namespaceripple_1_1Tuning.html#a728589bd52b8426227390d5640782a10a5560358d1654b8d46cd3728b4aba826c">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="overlay_2impl_2Tuning_8h_source.html#l00061">overlay/impl/Tuning.h:61</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|