mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-05 05:40:14 +00:00
Updated docs and manual
This commit is contained in:
parent
ecffa1a7eb
commit
50799bd2a6
Binary file not shown.
@ -618,8 +618,8 @@ times and priorities described earlier in this chapter.
|
|||||||
|
|
||||||
.. _understanding-packetformat:
|
.. _understanding-packetformat:
|
||||||
|
|
||||||
Binary Packet Format
|
Wire Format
|
||||||
--------------------
|
-----------
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
@ -710,7 +710,7 @@ Binary Packet Format
|
|||||||
|
|
||||||
The following table lists example sizes of various
|
The following table lists example sizes of various
|
||||||
packet types. The size listed are the complete on-
|
packet types. The size listed are the complete on-
|
||||||
wire size including all fields.
|
wire size counting all fields including headers.
|
||||||
|
|
||||||
- Path Request : 33 bytes
|
- Path Request : 33 bytes
|
||||||
- Announce : 151 bytes
|
- Announce : 151 bytes
|
||||||
|
@ -123,7 +123,7 @@ to participate in the development of Reticulum itself.</p>
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="understanding.html#reference-setup">Reference Setup</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="understanding.html#reference-setup">Reference Setup</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="understanding.html#protocol-specifics">Protocol Specifics</a><ul>
|
<li class="toctree-l2"><a class="reference internal" href="understanding.html#protocol-specifics">Protocol Specifics</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="understanding.html#packet-prioritisation">Packet Prioritisation</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="understanding.html#packet-prioritisation">Packet Prioritisation</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="understanding.html#binary-packet-format">Binary Packet Format</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="understanding.html#wire-format">Wire Format</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
Binary file not shown.
@ -1173,13 +1173,16 @@ Transport system of Reticulum.</p>
|
|||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="RNS.Transport.request_path">
|
<dt class="sig sig-object py" id="RNS.Transport.request_path">
|
||||||
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">request_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destination_hash</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Transport.request_path" title="Permalink to this definition">¶</a></dt>
|
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">request_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destination_hash</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_interface</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Transport.request_path" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Requests a path to the destination from the network. If
|
<dd><p>Requests a path to the destination from the network. If
|
||||||
another reachable peer on the network knows a path, it
|
another reachable peer on the network knows a path, it
|
||||||
will announce it.</p>
|
will announce it.</p>
|
||||||
<dl class="field-list simple">
|
<dl class="field-list simple">
|
||||||
<dt class="field-odd">Parameters</dt>
|
<dt class="field-odd">Parameters</dt>
|
||||||
<dd class="field-odd"><p><strong>destination_hash</strong> – A destination hash as <em>bytes</em>.</p>
|
<dd class="field-odd"><ul class="simple">
|
||||||
|
<li><p><strong>destination_hash</strong> – A destination hash as <em>bytes</em>.</p></li>
|
||||||
|
<li><p><strong>on_interface</strong> – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.</p></li>
|
||||||
|
</ul>
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
File diff suppressed because one or more lines are too long
@ -680,8 +680,8 @@ treated more as a reference than as essential reading.</p>
|
|||||||
on a first-come, first-serve basis. Announce re-transmission are handled according to the re-transmission
|
on a first-come, first-serve basis. Announce re-transmission are handled according to the re-transmission
|
||||||
times and priorities described earlier in this chapter.</p>
|
times and priorities described earlier in this chapter.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="binary-packet-format">
|
<div class="section" id="wire-format">
|
||||||
<span id="understanding-packetformat"></span><h3>Binary Packet Format<a class="headerlink" href="#binary-packet-format" title="Permalink to this headline">¶</a></h3>
|
<span id="understanding-packetformat"></span><h3>Wire Format<a class="headerlink" href="#wire-format" title="Permalink to this headline">¶</a></h3>
|
||||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>== Reticulum Wire Format ======
|
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>== Reticulum Wire Format ======
|
||||||
|
|
||||||
A Reticulum packet is composed of the following fields:
|
A Reticulum packet is composed of the following fields:
|
||||||
@ -769,7 +769,7 @@ proof 11
|
|||||||
|
|
||||||
The following table lists example sizes of various
|
The following table lists example sizes of various
|
||||||
packet types. The size listed are the complete on-
|
packet types. The size listed are the complete on-
|
||||||
wire size including all fields.
|
wire size counting all fields including headers.
|
||||||
|
|
||||||
- Path Request : 33 bytes
|
- Path Request : 33 bytes
|
||||||
- Announce : 151 bytes
|
- Announce : 151 bytes
|
||||||
@ -818,7 +818,7 @@ proof 11
|
|||||||
<li><a class="reference internal" href="#reference-setup">Reference Setup</a></li>
|
<li><a class="reference internal" href="#reference-setup">Reference Setup</a></li>
|
||||||
<li><a class="reference internal" href="#protocol-specifics">Protocol Specifics</a><ul>
|
<li><a class="reference internal" href="#protocol-specifics">Protocol Specifics</a><ul>
|
||||||
<li><a class="reference internal" href="#packet-prioritisation">Packet Prioritisation</a></li>
|
<li><a class="reference internal" href="#packet-prioritisation">Packet Prioritisation</a></li>
|
||||||
<li><a class="reference internal" href="#binary-packet-format">Binary Packet Format</a></li>
|
<li><a class="reference internal" href="#wire-format">Wire Format</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -618,8 +618,8 @@ times and priorities described earlier in this chapter.
|
|||||||
|
|
||||||
.. _understanding-packetformat:
|
.. _understanding-packetformat:
|
||||||
|
|
||||||
Binary Packet Format
|
Wire Format
|
||||||
--------------------
|
-----------
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
@ -710,7 +710,7 @@ Binary Packet Format
|
|||||||
|
|
||||||
The following table lists example sizes of various
|
The following table lists example sizes of various
|
||||||
packet types. The size listed are the complete on-
|
packet types. The size listed are the complete on-
|
||||||
wire size including all fields.
|
wire size counting all fields including headers.
|
||||||
|
|
||||||
- Path Request : 33 bytes
|
- Path Request : 33 bytes
|
||||||
- Announce : 151 bytes
|
- Announce : 151 bytes
|
||||||
|
Loading…
Reference in New Issue
Block a user