Remzona54/Reticulum
2
1
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-09-27 18:46:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Updated docs

Browse source
This commit is contained in:
Mark Qvist 2026-08-22 14:54:40 +02:00
parent 561e2f23e1
commit e32d4df754
No known key found for this signature in database
5 changed files with 49 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/manual/genindex.html
View file

@ -442,8 +442,12 @@
<li><a href="reference.html#RNS.Resource.get_hash">get_hash() (RNS.Resource method)</a>
</li>
<li><a href="reference.html#RNS.Reticulum.get_instance">get_instance() (RNS.Reticulum static method)</a>
</li>
<li><a href="reference.html#RNS.Reticulum.get_lowest_interface_bitrate">get_lowest_interface_bitrate() (RNS.Reticulum method)</a>
</li>
<li><a href="reference.html#RNS.Link.get_mdu">get_mdu() (RNS.Link method)</a>
</li>
<li><a href="reference.html#RNS.Reticulum.get_medium_path_timeout">get_medium_path_timeout() (RNS.Reticulum method)</a>
</li>
<li><a href="reference.html#RNS.Link.get_mode">get_mode() (RNS.Link method)</a>
</li>

BIN
docs/manual/objects.inv
View file

Binary file not shown.

27
docs/manual/reference.html
View file

@ -365,6 +365,31 @@ known, returns <code class="docutils literal notranslate"><span class="pre">DEFA
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="RNS.Reticulum.get_lowest_interface_bitrate">
<span class="sig-name descname"><span class="pre">get_lowest_interface_bitrate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Reticulum.get_lowest_interface_bitrate" title="Link to this definition"></a></dt>
<dd><p>Returns the bitrate of the slowest currently online
interface, or None if no online interface bitrate</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Lowest online interface bitrate in bits per second, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="RNS.Reticulum.get_medium_path_timeout">
<span class="sig-name descname"><span class="pre">get_medium_path_timeout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Reticulum.get_medium_path_timeout" title="Link to this definition"></a></dt>
<dd><p>Returns an estimate of a reasonable minimum path request timeout covering
a full round trip for an MTU on the slowest currently online interface
plus per hop grace</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Timeout in seconds or 0 if it’s unknown.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="RNS.Reticulum.should_use_implicit_proof">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </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="Link to this definition"></a></dt>
@ -2364,6 +2389,8 @@ will announce it.</p>
<li><a class="reference internal" href="#RNS.Reticulum.DEFAULT_PER_HOP_TIMEOUT"><code class="docutils literal notranslate"><span class="pre">DEFAULT_PER_HOP_TIMEOUT</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.get_instance"><code class="docutils literal notranslate"><span class="pre">get_instance()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.get_first_hop_timeout"><code class="docutils literal notranslate"><span class="pre">get_first_hop_timeout()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.get_lowest_interface_bitrate"><code class="docutils literal notranslate"><span class="pre">get_lowest_interface_bitrate()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.get_medium_path_timeout"><code class="docutils literal notranslate"><span class="pre">get_medium_path_timeout()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.should_use_implicit_proof"><code class="docutils literal notranslate"><span class="pre">should_use_implicit_proof()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.transport_enabled"><code class="docutils literal notranslate"><span class="pre">transport_enabled()</span></code></a></li>
<li><a class="reference internal" href="#RNS.Reticulum.link_mtu_discovery"><code class="docutils literal notranslate"><span class="pre">link_mtu_discovery()</span></code></a></li>

2
docs/manual/searchindex.js
View file

File diff suppressed because one or more lines are too long

17
docs/markdown/reference.md
View file

@ -91,6 +91,23 @@ known, returns `DEFAULT_PER_HOP_TIMEOUT`.
* **Returns:**
First-hop timeout, in seconds.
#### `get_lowest_interface_bitrate()`
Returns the bitrate of the slowest currently online
interface, or None if no online interface bitrate
* **Returns:**
Lowest online interface bitrate in bits per second, or `None`.
#### `get_medium_path_timeout()`
Returns an estimate of a reasonable minimum path request timeout covering
a full round trip for an MTU on the slowest currently online interface
plus per hop grace
* **Returns:**
Timeout in seconds or 0 if it’s unknown.
#### `static should_use_implicit_proof()`
Returns whether proofs sent are explicit or implicit.