mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-05 05:40:14 +00:00
Updated documentation
This commit is contained in:
parent
00d8a2064d
commit
406ab216d1
Binary file not shown.
Binary file not shown.
@ -769,12 +769,12 @@ Ingress Announce Control
|
|||||||
On public interfaces, where anyone may connect and announce new destinations,
|
On public interfaces, where anyone may connect and announce new destinations,
|
||||||
it can be useful to control the rate at which new announces ingress.
|
it can be useful to control the rate at which new announces ingress.
|
||||||
|
|
||||||
If a large influx of annonuces for newly created or previously unknown destinations
|
If a large influx of announces for newly created or previously unknown destinations
|
||||||
occur, Reticulum will place these announces on hold, so that announce traffic
|
occur, Reticulum will place these announces on hold, so that announce traffic
|
||||||
for known and previously established destinations can continue to be processed
|
for known and previously established destinations can continue to be processed
|
||||||
without interruptions.
|
without interruptions.
|
||||||
|
|
||||||
By default, Reticulum will handle this automatically, and ingress annonuce
|
By default, Reticulum will handle this automatically, and ingress announce
|
||||||
control will be enabled on interface where it is sensible to do so. It should
|
control will be enabled on interface where it is sensible to do so. It should
|
||||||
generally not be neccessary to modify the ingress control configuration,
|
generally not be neccessary to modify the ingress control configuration,
|
||||||
but all the parameters are exposed for configuration if needed.
|
but all the parameters are exposed for configuration if needed.
|
||||||
@ -788,11 +788,11 @@ but all the parameters are exposed for configuration if needed.
|
|||||||
option is useful on publicly accessible interfaces that spawn new
|
option is useful on publicly accessible interfaces that spawn new
|
||||||
sub-interfaces when a new client connects.
|
sub-interfaces when a new client connects.
|
||||||
|
|
||||||
* | The ``ic_burst_freq_new`` option sets the maximum annonuce ingress
|
* | The ``ic_burst_freq_new`` option sets the maximum announce ingress
|
||||||
frequency for newly spawned interfaces. Defaults to ``3.5``
|
frequency for newly spawned interfaces. Defaults to ``3.5``
|
||||||
announces per second.
|
announces per second.
|
||||||
|
|
||||||
* | The ``ic_burst_freq`` option sets the maximum annonuce ingress
|
* | The ``ic_burst_freq`` option sets the maximum announce ingress
|
||||||
frequency for other interfaces. Defaults to ``12`` announces
|
frequency for other interfaces. Defaults to ``12`` announces
|
||||||
per second.
|
per second.
|
||||||
|
|
||||||
|
@ -941,11 +941,11 @@ that a large span of network types can seamlessly <em>co-exist</em> and intercon
|
|||||||
<span id="interfaces-ingress-control"></span><h2>Ingress Announce Control<a class="headerlink" href="#ingress-announce-control" title="Permalink to this heading">#</a></h2>
|
<span id="interfaces-ingress-control"></span><h2>Ingress Announce Control<a class="headerlink" href="#ingress-announce-control" title="Permalink to this heading">#</a></h2>
|
||||||
<p>On public interfaces, where anyone may connect and announce new destinations,
|
<p>On public interfaces, where anyone may connect and announce new destinations,
|
||||||
it can be useful to control the rate at which new announces ingress.</p>
|
it can be useful to control the rate at which new announces ingress.</p>
|
||||||
<p>If a large influx of annonuces for newly created or previously unknown destinations
|
<p>If a large influx of announces for newly created or previously unknown destinations
|
||||||
occur, Reticulum will place these announces on hold, so that announce traffic
|
occur, Reticulum will place these announces on hold, so that announce traffic
|
||||||
for known and previously established destinations can continue to be processed
|
for known and previously established destinations can continue to be processed
|
||||||
without interruptions.</p>
|
without interruptions.</p>
|
||||||
<p>By default, Reticulum will handle this automatically, and ingress annonuce
|
<p>By default, Reticulum will handle this automatically, and ingress announce
|
||||||
control will be enabled on interface where it is sensible to do so. It should
|
control will be enabled on interface where it is sensible to do so. It should
|
||||||
generally not be neccessary to modify the ingress control configuration,
|
generally not be neccessary to modify the ingress control configuration,
|
||||||
but all the parameters are exposed for configuration if needed.</p>
|
but all the parameters are exposed for configuration if needed.</p>
|
||||||
@ -965,13 +965,13 @@ sub-interfaces when a new client connects.</div>
|
|||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><div class="line-block">
|
<li><div class="line-block">
|
||||||
<div class="line">The <code class="docutils literal notranslate"><span class="pre">ic_burst_freq_new</span></code> option sets the maximum annonuce ingress
|
<div class="line">The <code class="docutils literal notranslate"><span class="pre">ic_burst_freq_new</span></code> option sets the maximum announce ingress
|
||||||
frequency for newly spawned interfaces. Defaults to <code class="docutils literal notranslate"><span class="pre">3.5</span></code>
|
frequency for newly spawned interfaces. Defaults to <code class="docutils literal notranslate"><span class="pre">3.5</span></code>
|
||||||
announces per second.</div>
|
announces per second.</div>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><div class="line-block">
|
<li><div class="line-block">
|
||||||
<div class="line">The <code class="docutils literal notranslate"><span class="pre">ic_burst_freq</span></code> option sets the maximum annonuce ingress
|
<div class="line">The <code class="docutils literal notranslate"><span class="pre">ic_burst_freq</span></code> option sets the maximum announce ingress
|
||||||
frequency for other interfaces. Defaults to <code class="docutils literal notranslate"><span class="pre">12</span></code> announces
|
frequency for other interfaces. Defaults to <code class="docutils literal notranslate"><span class="pre">12</span></code> announces
|
||||||
per second.</div>
|
per second.</div>
|
||||||
</div>
|
</div>
|
||||||
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user