mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-26 14:05:51 +00:00
214 lines
12 KiB
HTML
214 lines
12 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.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::HashRouter::Setup 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.5 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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="classripple_1_1HashRouter.html">HashRouter</a></li><li class="navelem"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html">Setup</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structripple_1_1HashRouter_1_1Setup-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::HashRouter::Setup Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Structure used to customize <a class="el" href="classripple_1_1HashRouter.html">HashRouter</a> behavior.
|
|
<a href="structripple_1_1HashRouter_1_1Setup.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="HashRouter_8h_source.html">HashRouter.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::HashRouter::Setup:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structripple_1_1HashRouter_1_1Setup__coll__graph.png" border="0" usemap="#aripple_1_1HashRouter_1_1Setup_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1HashRouter_1_1Setup_coll__map" id="aripple_1_1HashRouter_1_1Setup_coll__map">
|
|
<area shape="rect" title="Structure used to customize HashRouter behavior." alt="" coords="11,108,154,148"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="5,5,160,31"/>
|
|
</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-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:acce662b9620e78ec747b1edc12d7c4bb"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">seconds</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a></td></tr>
|
|
<tr class="separator:acce662b9620e78ec747b1edc12d7c4bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a15c6acc86390b61afe3c96b00d34e7b1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#a15c6acc86390b61afe3c96b00d34e7b1">Setup</a> ()=default</td></tr>
|
|
<tr class="memdesc:a15c6acc86390b61afe3c96b00d34e7b1"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="structripple_1_1HashRouter_1_1Setup.html#a15c6acc86390b61afe3c96b00d34e7b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a15c6acc86390b61afe3c96b00d34e7b1"><td class="memSeparator" colspan="2"> </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:a9a5e1a72f62bd323048695746aceac2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">seconds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#a9a5e1a72f62bd323048695746aceac2f">holdTime</a> {300}</td></tr>
|
|
<tr class="memdesc:a9a5e1a72f62bd323048695746aceac2f"><td class="mdescLeft"> </td><td class="mdescRight">Expiration time for a hash entry. <a href="structripple_1_1HashRouter_1_1Setup.html#a9a5e1a72f62bd323048695746aceac2f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a5e1a72f62bd323048695746aceac2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7ed7b84a49e3bed0db973ebc678bfdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">seconds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#ad7ed7b84a49e3bed0db973ebc678bfdd">relayTime</a> {30}</td></tr>
|
|
<tr class="memdesc:ad7ed7b84a49e3bed0db973ebc678bfdd"><td class="mdescLeft"> </td><td class="mdescRight">Amount of time required before a relayed item will be relayed again. <a href="structripple_1_1HashRouter_1_1Setup.html#ad7ed7b84a49e3bed0db973ebc678bfdd">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7ed7b84a49e3bed0db973ebc678bfdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Structure used to customize <a class="el" href="classripple_1_1HashRouter.html">HashRouter</a> behavior. </p>
|
|
<p >Even though these items are configurable, they are undocumented. Don't change them unless there is a good reason, and network-wide coordination to do it.</p>
|
|
<p >Configuration is processed in setup_HashRouter. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="HashRouter_8h_source.html#l00070">70</a> of file <a class="el" href="HashRouter_8h_source.html">HashRouter.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="acce662b9620e78ec747b1edc12d7c4bb" name="acce662b9620e78ec747b1edc12d7c4bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acce662b9620e78ec747b1edc12d7c4bb">◆ </a></span>seconds</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">ripple::HashRouter::Setup::seconds</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="HashRouter_8h_source.html#l00075">75</a> of file <a class="el" href="HashRouter_8h_source.html">HashRouter.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a15c6acc86390b61afe3c96b00d34e7b1" name="a15c6acc86390b61afe3c96b00d34e7b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15c6acc86390b61afe3c96b00d34e7b1">◆ </a></span>Setup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::HashRouter::Setup::Setup </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a9a5e1a72f62bd323048695746aceac2f" name="a9a5e1a72f62bd323048695746aceac2f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a5e1a72f62bd323048695746aceac2f">◆ </a></span>holdTime</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">seconds</a> ripple::HashRouter::Setup::holdTime {300}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Expiration time for a hash entry. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="HashRouter_8h_source.html#l00079">79</a> of file <a class="el" href="HashRouter_8h_source.html">HashRouter.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7ed7b84a49e3bed0db973ebc678bfdd" name="ad7ed7b84a49e3bed0db973ebc678bfdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7ed7b84a49e3bed0db973ebc678bfdd">◆ </a></span>relayTime</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1HashRouter_1_1Setup.html#acce662b9620e78ec747b1edc12d7c4bb">seconds</a> ripple::HashRouter::Setup::relayTime {30}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Amount of time required before a relayed item will be relayed again. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="HashRouter_8h_source.html#l00083">83</a> of file <a class="el" href="HashRouter_8h_source.html">HashRouter.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|