mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-07-25 17:18:12 -07:00
Added gravity, default_gravity and autoconnect_interface_gravity options and updated documentation
This commit is contained in:
@@ -1200,6 +1200,15 @@ These can be used to control various aspects of interface behaviour.
|
||||
expected to connect momentarily, use the network, and then
|
||||
disappear again.
|
||||
|
||||
- See the :ref:`Interface Modes<interfaces-modes>` section
|
||||
below for a reference on additional modes.
|
||||
|
||||
* | The ``gravity`` option specifies the pathing affinity of an interface.
|
||||
If not set specifically, and unless otherwise configured by
|
||||
``default_gravity`` or ``autoconnect_interface_gravity``,
|
||||
it defaults to ``0``. Positive values increase pathing affinity,
|
||||
and negative values decrease it.
|
||||
|
||||
* | The ``outgoing`` option sets whether an interface is allowed
|
||||
to transmit. Defaults to ``True``. If set to ``False`` or ``No``
|
||||
the interface will only receive data, and never transmit.
|
||||
|
||||
@@ -1335,10 +1335,20 @@ someone is actually using them. An example of this could
|
||||
be a radio interface serving a wide area, where users are
|
||||
expected to connect momentarily, use the network, and then
|
||||
disappear again.</p></li>
|
||||
<li><p>See the <a class="reference internal" href="#interfaces-modes"><span class="std std-ref">Interface Modes</span></a> section
|
||||
below for a reference on additional modes.</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</li>
|
||||
<li><div class="line-block">
|
||||
<div class="line">The <code class="docutils literal notranslate"><span class="pre">gravity</span></code> option specifies the pathing affinity of an interface.
|
||||
If not set specifically, and unless otherwise configured by
|
||||
<code class="docutils literal notranslate"><span class="pre">default_gravity</span></code> or <code class="docutils literal notranslate"><span class="pre">autoconnect_interface_gravity</span></code>,
|
||||
it defaults to <code class="docutils literal notranslate"><span class="pre">0</span></code>. Positive values increase pathing affinity,
|
||||
and negative values decrease it.</div>
|
||||
</div>
|
||||
</li>
|
||||
<li><div class="line-block">
|
||||
<div class="line">The <code class="docutils literal notranslate"><span class="pre">outgoing</span></code> option sets whether an interface is allowed
|
||||
to transmit. Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">False</span></code> or <code class="docutils literal notranslate"><span class="pre">No</span></code>
|
||||
the interface will only receive data, and never transmit.</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1131,6 +1131,14 @@ These can be used to control various aspects of interface behaviour.
|
||||
> > be a radio interface serving a wide area, where users are
|
||||
> > expected to connect momentarily, use the network, and then
|
||||
> > disappear again.
|
||||
> > - See the [Interface Modes](#interfaces-modes) section
|
||||
> > below for a reference on additional modes.
|
||||
> * The `gravity` option specifies the pathing affinity of an interface.
|
||||
> If not set specifically, and unless otherwise configured by
|
||||
> `default_gravity` or `autoconnect_interface_gravity`,
|
||||
> it defaults to `0`. Positive values increase pathing affinity,
|
||||
> and negative values decrease it.
|
||||
>
|
||||
> * The `outgoing` option sets whether an interface is allowed
|
||||
> to transmit. Defaults to `True`. If set to `False` or `No`
|
||||
> the interface will only receive data, and never transmit.
|
||||
|
||||
@@ -1200,6 +1200,15 @@ These can be used to control various aspects of interface behaviour.
|
||||
expected to connect momentarily, use the network, and then
|
||||
disappear again.
|
||||
|
||||
- See the :ref:`Interface Modes<interfaces-modes>` section
|
||||
below for a reference on additional modes.
|
||||
|
||||
* | The ``gravity`` option specifies the pathing affinity of an interface.
|
||||
If not set specifically, and unless otherwise configured by
|
||||
``default_gravity`` or ``autoconnect_interface_gravity``,
|
||||
it defaults to ``0``. Positive values increase pathing affinity,
|
||||
and negative values decrease it.
|
||||
|
||||
* | The ``outgoing`` option sets whether an interface is allowed
|
||||
to transmit. Defaults to ``True``. If set to ``False`` or ``No``
|
||||
the interface will only receive data, and never transmit.
|
||||
|
||||
Reference in New Issue
Block a user