William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-22 13:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated packet sizes in docs

Browse Source
This commit is contained in:
Mark Qvist 2022-07-02 08:45:57 +02:00
parent d33154bfdb
commit 474521056b
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -42,8 +42,8 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects
- The API is very easy to use, and provides transfer progress - The API is very easy to use, and provides transfer progress
- Lightweight, flexible and expandable Request/Response mechanism - Lightweight, flexible and expandable Request/Response mechanism
- Efficient link establishment - Efficient link establishment
- Total bandwidth cost of setting up an encrypted link is 3 packets totalling 237 bytes - Total bandwidth cost of setting up an encrypted link is 3 packets totalling 265 bytes
- Low cost of keeping links open at only 0.62 bits per second - Low cost of keeping links open at only 0.44 bits per second
## Examples of Reticulum Applications ## Examples of Reticulum Applications
If you want to quickly get an idea of what Reticulum can do, take a look at the following resources. If you want to quickly get an idea of what Reticulum can do, take a look at the following resources.

18
docs/source/understanding.rst
View File

@ -493,10 +493,10 @@ terms of bandwidth, so it can be used just for a short exchange, and then recrea
also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is
more suitable to the application. The procedure also inserts the *link id* , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this *link id*. more suitable to the application. The procedure also inserts the *link id* , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this *link id*.
The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the The combined bandwidth cost of setting up a link is 3 packets totalling 265 bytes (more info in the
:ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping :ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping
a link open is practically negligible, at 0.62 bits per second. Even on a slow 1200 bits per second packet a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
radio channel, 100 concurrent links will still leave 95% channel capacity for actual data. radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.
Link Establishment in Detail Link Establishment in Detail
@ -795,12 +795,12 @@ Wire Format
wire size counting all fields including headers, wire size counting all fields including headers,
but excluding any interface access codes. but excluding any interface access codes.
- Path Request : 33 bytes - Path Request : 51 bytes
- Announce : 151 bytes - Announce : 157 bytes
- Link Request : 77 bytes - Link Request : 83 bytes
- Link Proof : 77 bytes - Link Proof : 83 bytes
- Link RTT packet : 83 bytes - Link RTT packet : 99 bytes
- Link keepalive : 14 bytes - Link keepalive : 20 bytes
.. _understanding-announcepropagation: .. _understanding-announcepropagation:

4
docs/source/whatis.rst
View File

@ -46,9 +46,9 @@ What does Reticulum Offer?
* Efficient link establishment * Efficient link establishment
* Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes * Total bandwidth cost of setting up a link is only 3 packets, totalling 265 bytes
* Low cost of keeping links open at only 0.62 bits per second * Low cost of keeping links open at only 0.44 bits per second
* Reliable and efficient transfer of arbitrary amounts of data * Reliable and efficient transfer of arbitrary amounts of data