Updated documentation

docs/manual/_sources/interfaces.rst.txt

@@ -519,23 +519,24 @@ beaconing functionality described above.
 Common Interface Options
 ========================
 
-A number of general options can be used to control various
+A number of general options are available on most interfaces.
-aspects of interface behaviour.
+These can be used to control various aspects of interface behaviour.
 
-The ``interface_enabled`` option tells Reticulum whether or not
+
+The ``enabled`` option tells Reticulum whether or not
 to bring up the interface. Defaults to ``False``. For any
-interface to be brought up, the ``interface_enabled`` option
+interface to be brought up, the ``enabled`` option
 must be set to ``True`` or ``Yes``.
 
 The ``outgoing`` option sets whether an interface is allowed
-to transmit. Defaults to ``True``. If set to ``False`` the
+to transmit. Defaults to ``True``. If set to ``False`` or ``No``
-interface will only receive data, and never transmit.
+the interface will only receive data, and never transmit.
 
-The ``interface_mode`` option allows selecting the high-level
+The ``mode`` option allows selecting the high-level behaviour
-behaviour of the interface from a number of options.
+of the interface from a number of options.
 
  - The default value is ``full``. In this mode, all discovery,
-   meshing and transpor functionality is available.
+   meshing and transport functionality is available.
 
  - In the ``access_point`` (or shorthand ``ap``) mode, the
    interface will operate as a network access point. In this

docs/manual/genindex.html

@@ -60,10 +60,12 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference.html#RNS.Resource.advertise">advertise() (RNS.Resource method)</a>
+</li>
+      <li><a href="reference.html#RNS.Destination.announce">announce() (RNS.Destination method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference.html#RNS.Destination.announce">announce() (RNS.Destination method)</a>
+      <li><a href="reference.html#RNS.Reticulum.ANNOUNCE_CAP">ANNOUNCE_CAP (RNS.Reticulum attribute)</a>
 </li>
       <li><a href="reference.html#RNS.Destination.app_and_aspects_from_name">app_and_aspects_from_name() (RNS.Destination static method)</a>
 </li>

docs/manual/interfaces.html

@@ -487,21 +487,21 @@ beaconing functionality described above.</p>
 </div>
 <div class="section" id="common-interface-options">
 <span id="interfaces-options"></span><h2>Common Interface Options<a class="headerlink" href="#common-interface-options" title="Permalink to this headline">¶</a></h2>
-<p>A number of general options can be used to control various
+<p>A number of general options are available on most interfaces.
-aspects of interface behaviour.</p>
+These can be used to control various aspects of interface behaviour.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option tells Reticulum whether or not
+<p>The <code class="docutils literal notranslate"><span class="pre">enabled</span></code> option tells Reticulum whether or not
 to bring up the interface. Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code>. For any
-interface to be brought up, the <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option
+interface to be brought up, the <code class="docutils literal notranslate"><span class="pre">enabled</span></code> option
 must be set to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">Yes</span></code>.</p>
 <p>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> the
+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>
-interface will only receive data, and never transmit.</p>
+the interface will only receive data, and never transmit.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">interface_mode</span></code> option allows selecting the high-level
+<p>The <code class="docutils literal notranslate"><span class="pre">mode</span></code> option allows selecting the high-level behaviour
-behaviour of the interface from a number of options.</p>
+of the interface from a number of options.</p>
 <blockquote>
 <div><ul class="simple">
 <li><p>The default value is <code class="docutils literal notranslate"><span class="pre">full</span></code>. In this mode, all discovery,
-meshing and transpor functionality is available.</p></li>
+meshing and transport functionality is available.</p></li>
 <li><p>In the <code class="docutils literal notranslate"><span class="pre">access_point</span></code> (or shorthand <code class="docutils literal notranslate"><span class="pre">ap</span></code>) mode, the
 interface will operate as a network access point. In this
 mode, announces will not be automatically broadcasted on

docs/manual/reference.html

@@ -84,6 +84,23 @@ MTU is a prerequisite for peers to communicate in the same network.</p>
 the default value.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="RNS.Reticulum.ANNOUNCE_CAP">
+<span class="sig-name descname"><span class="pre">ANNOUNCE_CAP</span></span><em class="property"> <span class="pre">=</span> <span class="pre">2</span></em><a class="headerlink" href="#RNS.Reticulum.ANNOUNCE_CAP" title="Permalink to this definition">¶</a></dt>
+<dd><p>The maximum percentage of interface bandwidth that, at any given time,
+may be used to propagate announces. If an announce was scheduled for
+broadcasting on an interface, but doing so would exceed the allowed
+bandwidth allocation, the announce will be queued for transmission
+when there is bandwidth available.</p>
+<p>Reticulum will always prioritise propagating announces with fewer
+hops, ensuring that distant, large networks with many peers on fast
+links don’t overwhelm the capacity of smaller networks on slower
+mediums. If an announce remains queued for an extended amount of time,
+it will eventually be dropped.</p>
+<p>This value will be applied by default to all created interfaces,
+but it can be configured individually on a per-interface basis.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="RNS.Reticulum.should_use_implicit_proof">
 <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">should_use_implicit_proof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Reticulum.should_use_implicit_proof" title="Permalink to this definition">¶</a></dt>