From 0fe76d50f654bd05cbb70b05de70e8a41ef3c0c0 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 2 Sep 2021 20:35:42 +0200 Subject: [PATCH] Improved documentation. --- Examples/Filetransfer.py | 2 +- README.md | 2 +- RNS/Identity.py | 32 ++-- RNS/Link.py | 53 +++++- RNS/Packet.py | 9 +- RNS/Resource.py | 14 +- RNS/Reticulum.py | 6 +- RNS/Transport.py | 4 + RNS/__init__.py | 2 +- docs/manual/.buildinfo | 2 +- docs/manual/_sources/reference.rst.txt | 16 +- docs/manual/_sources/understanding.rst.txt | 4 +- docs/manual/_sources/whatis.rst.txt | 2 +- docs/manual/_static/documentation_options.js | 2 +- docs/manual/examples.html | 8 +- docs/manual/genindex.html | 43 +++-- docs/manual/gettingstartedfast.html | 6 +- docs/manual/index.html | 7 +- docs/manual/objects.inv | Bin 1583 -> 1638 bytes docs/manual/reference.html | 161 +++++++++++++------ docs/manual/search.html | 6 +- docs/manual/searchindex.js | 2 +- docs/manual/understanding.html | 10 +- docs/manual/whatis.html | 8 +- docs/source/conf.py | 2 +- docs/source/reference.rst | 16 +- docs/source/understanding.rst | 4 +- docs/source/whatis.rst | 2 +- 28 files changed, 285 insertions(+), 140 deletions(-) diff --git a/Examples/Filetransfer.py b/Examples/Filetransfer.py index 5edff29..8f66199 100644 --- a/Examples/Filetransfer.py +++ b/Examples/Filetransfer.py @@ -358,7 +358,7 @@ def print_menu(): print("") while menu_mode == "downloading": global current_download - percent = round(current_download.progress() * 100.0, 1) + percent = round(current_download.get_progress() * 100.0, 1) print(("\rProgress: "+str(percent)+" % "), end=' ') sys.stdout.flush() time.sleep(0.1) diff --git a/README.md b/README.md index 6e66cf1..1c95cdd 100755 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects - The API is very easy to use, and provides transfer progress - Lightweight, flexible and expandable Request/Response mechanism - Efficient link establishment - - Total bandwidth cost of setting up a link is 3 packets totalling 240 bytes + - Total bandwidth cost of setting up a link is 3 packets totalling 237 bytes - Low cost of keeping links open at only 0.62 bits per second ## Where can Reticulum be used? diff --git a/RNS/Identity.py b/RNS/Identity.py index a136f5b..b7e73e4 100644 --- a/RNS/Identity.py +++ b/RNS/Identity.py @@ -177,6 +177,22 @@ class Identity: Identity.save_known_destinations() + @staticmethod + def from_bytes(prv_bytes): + """ + Create a new :ref:`RNS.Identity` instance from *bytes* of private key. + Can be used to load previously created and saved identities into Reticulum. + + :param prv_bytes: The *bytes* of private a saved private key. **HAZARD!** Never use this to generate a new key by feeding random data in prv_bytes. + :returns: A :ref:`RNS.Identity` instance, or *None* if the *bytes* data was invalid. + """ + identity = Identity(create_keys=False) + if identity.load_private_key(prv_bytes): + return identity + else: + return None + + @staticmethod def from_file(path): """ @@ -210,22 +226,6 @@ class Identity: RNS.log("Error while saving identity to "+str(path), RNS.LOG_ERROR) RNS.log("The contained exception was: "+str(e)) - @staticmethod - def from_bytes(prv_bytes): - """ - Create a new :ref:`RNS.Identity` instance from *bytes* of private key. - Can be used to load previously created and saved identities into Reticulum. - - :param prv_bytes: The *bytes* of private a saved private key. **HAZARD!** Never not use this to generate a new key by feeding random data in prv_bytes. - :returns: A :ref:`RNS.Identity` instance, or *None* if the *bytes* data was invalid. - """ - identity = Identity(create_keys=False) - if identity.load_private_key(prv_bytes): - return identity - else: - return None - - def __init__(self,create_keys=True): # Initialize keys to none self.prv = None diff --git a/RNS/Link.py b/RNS/Link.py index d079e89..d9b0b64 100644 --- a/RNS/Link.py +++ b/RNS/Link.py @@ -27,14 +27,13 @@ class LinkCallbacks: class Link: """ - This class. + This class is used to establish and manage links to other peers. When a + link instance is created, Reticulum will attempt to establish verified + connectivity with the specified destination. :param destination: A :ref:`RNS.Destination` instance which to establish a link to. - :param established_callback: A function or method with the signature *callback(link)* to be called when the link has been established. - :param closed_callback: A function or method with the signature *callback(link)* to be called when the link is closed. - :param owner: Internal use by :ref:`RNS.Transport`, ignore this argument. - :param peer_pub_bytes: Internal use, ignore this argument. - :param peer_sig_pub_bytes: Internal use, ignore this argument. + :param established_callback: An optional function or method with the signature *callback(link)* to be called when the link has been established. + :param closed_callback: An optional function or method with the signature *callback(link)* to be called when the link is closed. """ CURVE = RNS.Identity.CURVE """ @@ -870,6 +869,12 @@ class Link: class RequestReceipt(): + """ + An instance of this class is returned by the ``request`` method of ``RNS.Link`` + instances. It should never be instantiated manually. It provides methods to + check status, response time and response data when the request concludes. + """ + FAILED = 0x00 SENT = 0x01 DELIVERED = 0x02 @@ -942,7 +947,7 @@ class RequestReceipt(): self.callbacks.failed(self) def response_resource_progress(self, resource): - self.progress = resource.progress() + self.progress = resource.get_progress() self.__resource_response_timeout = time.time()+self.timeout if self.callbacks.progress != None: @@ -979,9 +984,41 @@ class RequestReceipt(): if self.callbacks.response != None: self.callbacks.response(self) - def response_time(self): + def get_request_id(self): + """ + :returns: The request ID as *bytes*. + """ + return self.request_id + + def get_status(self): + """ + :returns: The current status of the request, one of ``RNS.RequestReceipt.FAILED``, ``RNS.RequestReceipt.SENT``, ``RNS.RequestReceipt.DELIVERED``, ``RNS.RequestReceipt.READY``. + """ + return self.status + + def get_progress(self): + """ + :returns: The progress of a response being received as a *float* between 0.0 and 1.0. + """ + return self.progress + + def get_response(self): + """ + :returns: The response as *bytes* if it is ready, otherwise *None*. + """ + if self.status == RequestReceipt.READY: + return self.response + else: + return None + + def get_response_time(self): + """ + :returns: The response time of the request in seconds. + """ if self.status == RequestReceipt.READY: return self.response_concluded_at - self.started_at + else: + return None diff --git a/RNS/Packet.py b/RNS/Packet.py index 3e351f8..9d3fa8a 100755 --- a/RNS/Packet.py +++ b/RNS/Packet.py @@ -20,11 +20,6 @@ class Packet: :param destination: A :ref:`RNS.Destination` instance to which the packet will be sent. :param data: The data payload to be included in the packet as *bytes*. :param create_receipt: Specifies whether a :ref:`RNS.PacketReceipt` should be created when instantiating the packet. - :param type: Internal use by :ref:`RNS.Transport`. Defaults to ``RNS.Packet.DATA``, and should not be specified. - :param context: Internal use by :ref:`RNS.Transport`. Ignore. - :param transport_type: Internal use by :ref:`RNS.Transport`. Ignore. - :param transport_id: Internal use by :ref:`RNS.Transport`. Ignore. - :param attached_interface: Internal use by :ref:`RNS.Transport`. Ignore. """ # Packet types @@ -309,8 +304,8 @@ class PacketReceipt: """ The PacketReceipt class is used to receive notifications about :ref:`RNS.Packet` instances sent over the network. Instances - of this class should never be created manually, but always returned - from a the *send()* method of a :ref:`RNS.Packet` instance. + of this class are never created manually, but always returned from + the *send()* method of a :ref:`RNS.Packet` instance. """ # Receipt status constants FAILED = 0x00 diff --git a/RNS/Resource.py b/RNS/Resource.py index d389568..311713d 100644 --- a/RNS/Resource.py +++ b/RNS/Resource.py @@ -15,14 +15,10 @@ class Resource: :param data: The data to be transferred. Can be *bytes* or an open *file handle*. See the :ref:`Filetransfer Example` for details. :param link: The :ref:`RNS.Link` instance on which to transfer the data. - :param advertise: Whether to automatically advertise the resource. Can be *True* or *False*. - :param auto_compress: Whether to auto-compress the resource. Can be *True* or *False*. - :param callback: A *callable* with the signature *callback(resource)*. Will be called when the resource transfer concludes. - :param progress_callback: A *callable* with the signature *callback(resource)*. Will be called whenever the resource transfer progress is updated. - :param segment_index: Internal use, ignore. - :param original_hash: Internal use, ignore. - :param is_request: Internal use, ignore. - :param is_response: Internal use, ignore. + :param advertise: Optional. Whether to automatically advertise the resource. Can be *True* or *False*. + :param auto_compress: Optional. Whether to auto-compress the resource. Can be *True* or *False*. + :param callback: An optional *callable* with the signature *callback(resource)*. Will be called when the resource transfer concludes. + :param progress_callback: An optional *callable* with the signature *callback(resource)*. Will be called whenever the resource transfer progress is updated. """ WINDOW_FLEXIBILITY = 4 WINDOW_MIN = 1 @@ -756,7 +752,7 @@ class Resource: def progress_callback(self, callback): self.__progress_callback = callback - def progress(self): + def get_progress(self): """ :returns: The current progress of the resource transfer as a *float* between 0.0 and 1.0. """ diff --git a/RNS/Reticulum.py b/RNS/Reticulum.py index d10dd38..5891777 100755 --- a/RNS/Reticulum.py +++ b/RNS/Reticulum.py @@ -36,6 +36,8 @@ class Reticulum: other programs to use on demand. """ + # Future minimum will probably be locked in at 244 bytes to support + # networks with segments of different MTUs. Absolute minimum is 211. MTU = 500 """ The MTU that Reticulum adheres to, and will expect other peers to @@ -44,8 +46,8 @@ class Reticulum: completely break compatibility with all other RNS networks. An identical MTU is a prerequisite for peers to communicate in the same network. - The absolute minimum MTU that Reticulum will function with is 215 bytes, - but bandwidth efficiency will be significantly impacted. + Unless you really know what you are doing, the MTU should be left at + the default value. """ # Length of truncated hashes in bits. diff --git a/RNS/Transport.py b/RNS/Transport.py index a1a8463..25b380f 100755 --- a/RNS/Transport.py +++ b/RNS/Transport.py @@ -9,6 +9,10 @@ from time import sleep from .vendor import umsgpack as umsgpack class Transport: + """ + Through static methods of this class you can interact with Reticulums + Transport system. + """ # Constants BROADCAST = 0x00; TRANSPORT = 0x01; diff --git a/RNS/__init__.py b/RNS/__init__.py index e256f1e..ff395b3 100755 --- a/RNS/__init__.py +++ b/RNS/__init__.py @@ -9,7 +9,7 @@ from ._version import __version__ from .Reticulum import Reticulum from .Identity import Identity -from .Link import Link +from .Link import Link, RequestReceipt from .Transport import Transport from .Destination import Destination from .Packet import Packet diff --git a/docs/manual/.buildinfo b/docs/manual/.buildinfo index cddb72d..bc8cfc4 100644 --- a/docs/manual/.buildinfo +++ b/docs/manual/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 75fee65d4971d4f4b61034cb277ccd5b +config: eda3a1317314f558917722e3479f8836 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/manual/_sources/reference.rst.txt b/docs/manual/_sources/reference.rst.txt index b5d3cf0..e09ec49 100644 --- a/docs/manual/_sources/reference.rst.txt +++ b/docs/manual/_sources/reference.rst.txt @@ -39,7 +39,7 @@ Destination Packet ------ -.. autoclass:: RNS.Packet +.. autoclass:: RNS.Packet(destination, data, create_receipt = True) :members: .. _api-packetreceipt: @@ -47,7 +47,7 @@ Packet Packet Receipt -------------- -.. autoclass:: RNS.PacketReceipt +.. autoclass:: RNS.PacketReceipt() :members: .. _api-link: @@ -55,7 +55,15 @@ Packet Receipt Link ---- -.. autoclass:: RNS.Link +.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None) + :members: + +.. _api-requestreceipt: + +Request Receipt +--------------- + +.. autoclass:: RNS.RequestReceipt() :members: .. _api-resource: @@ -63,7 +71,7 @@ Link Resource -------- -.. autoclass:: RNS.Resource +.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None) :members: .. _api-transport: diff --git a/docs/manual/_sources/understanding.rst.txt b/docs/manual/_sources/understanding.rst.txt index 8acb773..3766191 100644 --- a/docs/manual/_sources/understanding.rst.txt +++ b/docs/manual/_sources/understanding.rst.txt @@ -429,7 +429,7 @@ 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 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 240 bytes (more info in the +The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the :ref:`Binary Packet Format` 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 radio channel, 100 concurrent links will still leave 95% channel capacity for actual data. @@ -701,5 +701,5 @@ Binary Packet Format - Announce : 151 bytes - Link Request : 77 bytes - Link Proof : 77 bytes - - Link RTT packet : 86 bytes + - Link RTT packet : 83 bytes - Link keepalive : 14 bytes \ No newline at end of file diff --git a/docs/manual/_sources/whatis.rst.txt b/docs/manual/_sources/whatis.rst.txt index 2505423..1a6dcaa 100644 --- a/docs/manual/_sources/whatis.rst.txt +++ b/docs/manual/_sources/whatis.rst.txt @@ -57,7 +57,7 @@ What does Reticulum Offer? * Efficient link establishment - * Total bandwidth cost of setting up a link is only 3 packets, totalling 240 bytes + * Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes * Low cost of keeping links open at only 0.62 bits per second diff --git a/docs/manual/_static/documentation_options.js b/docs/manual/_static/documentation_options.js index 6914647..6b2d67c 100644 --- a/docs/manual/_static/documentation_options.js +++ b/docs/manual/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.2.3 beta', + VERSION: '0.2.4 beta', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/manual/examples.html b/docs/manual/examples.html index 6552a1f..c33edef 100644 --- a/docs/manual/examples.html +++ b/docs/manual/examples.html @@ -5,7 +5,7 @@ - Examples — Reticulum Network Stack 0.2.3 beta documentation + Examples — Reticulum Network Stack 0.2.4 beta documentation @@ -27,7 +27,7 @@
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Examples
    • @@ -2017,7 +2017,7 @@ interface to efficiently pass files of any size over a Reticulum print("") while menu_mode == "downloading": global current_download - percent = round(current_download.progress() * 100.0, 1) + percent = round(current_download.get_progress() * 100.0, 1) print(("\rProgress: "+str(percent)+" % "), end=' ') sys.stdout.flush() time.sleep(0.1) @@ -2319,7 +2319,7 @@ interface to efficiently pass files of any size over a Reticulum previous | -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Examples
    • diff --git a/docs/manual/genindex.html b/docs/manual/genindex.html index 2208748..bab5e26 100644 --- a/docs/manual/genindex.html +++ b/docs/manual/genindex.html @@ -5,7 +5,7 @@ - Index — Reticulum Network Stack 0.2.3 beta documentation + Index — Reticulum Network Stack 0.2.4 beta documentation @@ -23,7 +23,7 @@
  • index
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Index
    • @@ -47,6 +47,7 @@ | I | K | L + | M | N | P | R @@ -152,20 +153,36 @@ +
  • get_progress() (RNS.RequestReceipt method) + +
  • get_public_key() (RNS.Identity method) +
    • +
  • get_random_hash() (RNS.Identity static method)
    • @@ -229,6 +246,14 @@ +

    M

    + + +
    +

    N

    @@ -270,11 +293,13 @@
  • register_request_handler() (RNS.Destination method)
    • - - + diff --git a/docs/manual/gettingstartedfast.html b/docs/manual/gettingstartedfast.html index 1ebb6bb..9b427a1 100644 --- a/docs/manual/gettingstartedfast.html +++ b/docs/manual/gettingstartedfast.html @@ -5,7 +5,7 @@ - Getting Started Fast — Reticulum Network Stack 0.2.3 beta documentation + Getting Started Fast — Reticulum Network Stack 0.2.4 beta documentation @@ -31,7 +31,7 @@
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Getting Started Fast
    • @@ -166,7 +166,7 @@ don’t use pip, but try this recipe:

  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Getting Started Fast
    • diff --git a/docs/manual/index.html b/docs/manual/index.html index a7c6bcb..ec96b70 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -5,7 +5,7 @@ - Reticulum Network Stack Manual — Reticulum Network Stack 0.2.3 beta documentation + Reticulum Network Stack Manual — Reticulum Network Stack 0.2.4 beta documentation @@ -27,7 +27,7 @@
  • next |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Reticulum Network Stack Manual
    • @@ -91,6 +91,7 @@ the development of Reticulum itself.

  • Packet
  • Packet Receipt
  • Link
    • +
  • Request Receipt
  • Resource
  • Transport
    • @@ -167,7 +168,7 @@ the development of Reticulum itself.

  • next |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Reticulum Network Stack Manual
    • diff --git a/docs/manual/objects.inv b/docs/manual/objects.inv index c6eaa0b0df83ad445c6e4178f629a767c363555a..a3a55471e2739686021f3ea5e5f2942dc642eceb 100644 GIT binary patch delta 1522 zcmV7PDM9w7!Vb`Ipz(@pbv^zi{IOm9>pkpl^S1gr--VCS^L+dK8m_+Wo_#$$ikxLU z>XK#ZHNHP8Ed8;RQ0zxl70|UDS!zQ0>#`-R)OZpqpnufBgL+SSO3mxR(xfnLWzJ<(qNs|Z`7ypb(W?Cwocs*$2QbN9wyns^%F$aG?8`%FCq^(fU z+EpE%(=2ukh$dKc4KMDI5txt!|=U1PvP$wfez(7N$ zGEa&ZGE&?R`b9HtN~6oHQ9?n^boYD()B9jcFU(%%f(53C*SLwc8*es&o`I>q*HA4pOjB>J zK}J_ocKKhSY%1O1p9sngzPG=@=z!*~wC}>GEVdUMB{7ofGWXEPEQsTbUuHs3Sbur- zeWHFic#zB3Q%h-ad+@x7F3gcC*7@JS!+h?8bvifloG_9jdYM>ik%gK=uId36)sLW5P&y9gAeS~dVWu>^ ztJ!b*da%_uf~P7;P9qw+HP~q*UVmZr$;EqxLQ}g$tb~B(JQmw9e)}`&@YEQVk;(9eq!l5(Hxzu3V%l@Fn z8MRzmanD7!3Mm&kQVu>3kZT0u*fb4KH8yZmnM=$z7{yujfRF^8HmqkSxZ*LV)gKI0 zTb0x6Fify*pq{C%R`LklY3?-Jrs!=ovc;+_2DZAPaeI8D?RlK(XwG;vTf?cp`OF}S Yoy}2S(G~L__&I>vmi+7Pf8~@VfKS8*xc~qF delta 1467 zcmV;s1w{Jh46h83hJTq&Z{s!)hVS_m0$TJI1HJC0a5l=u*w|~>PK)hDpe4#8LXj#- zZPx$3Ly4sI6`Qp8ltg@=m(*xD94VXCcJ_#+A`B_QSyUZAr4&gS{TT_IV}V(UXN4;1 zZ@)+PcbmR?n!F#O18l+wF~)1qYnKwMf@gjUKvk6>mL*75IDb_#$ptSHhRR^0lwu^3 z4Ckn(D$%wXQYhF(V5D&JhL187&2TD?l?ulMJ`ky}NCf_`hLNOzfKV(#onZ8u1>`lQ zS4I4QRZP;55v6;SzJFa~Rsjb;Zn6-Z=QcREE~oL5O2D%^1V1TB4$OyHbTa8e3ANJM=hw~O zu?CP*g6wOBJ)rSK(-qh02K?9f`*!hf@U*+l>+17-7e6M?^X>CXy!x_x4)q8qa*he8 zOO9#w`2MJ{499XpaTuj5pl>;H)D`8g&(^S0)2mPcrGEx)GDUpx;5dv;{whABYmTDX;lnpsssVBrOZ7Mhy^eck_pr#rAm_uXf39 zv5ddH?vi!9NuIy0LyW%0@p}HU2%EisYtuEb(R7%MNI2neVv36CTYZAq?i^fl$o-I} zpbav0x_+52 zR##wy6;2leqnaQ$IK`y$G_c~H4?GFXGXH4K!hhtW1^VgRqNP;uL=6b3scIR{w(leq z%9l6><@MM`krG33x(NOA*gWe&t?!Ot@>D4blsZ8kRt zH*y|(>L?xVUPsQN3)5()ZTebxoQ^}V$wn(L2_q$<=ZR%2a*%zsI16oBk&OP(xqnh| zCb6^*vOzPRj=(53e>v&IrWpm_G6&2E%ka;>++J-bSm<9tsbJ?HOnaZ(oG?ookGAZW z_Ik8!2cjpPB&Qh--I?rkj;^qJ=i*JH(CRD^t0ABz&nDJe9q;Wx>$2ooO|e;dXY>NL zK0=*jecElV?t=R}Zcu_Gyo#hne}Ag>TC3i+<7;%lckqsi1w@TyI!c`xdIK%@+S8sY zLr?m_P9NLpGErc+<)bBRS;UAe;b}mbSBTJo^Bzf(<{;MF2hma0pPXaClz?zH3?%l0 z_K2RkCWBczXAwiCjmr5+y8nw?HPFYVGR#j7oJ^wUwNS;dR!w@@9q`l=Lw`GtsLzVN zXx)G{XD`7%1`8)1xV+(`O_>rTK3?nQt7r5TA6@!1=)iegh9=$o(z@hIf2SRFD3g{; zCmy)8Cw9ty0^fb0Dvc;;dMz(E3<9GW;JMj3RqxrzY9u24d=DmO@_72DP VN?S4if!`w-cI01o{{ymTUI&sC)ZG98 diff --git a/docs/manual/reference.html b/docs/manual/reference.html index c3d82a4..b764332 100644 --- a/docs/manual/reference.html +++ b/docs/manual/reference.html @@ -5,7 +5,7 @@ - API Reference — Reticulum Network Stack 0.2.3 beta documentation + API Reference — Reticulum Network Stack 0.2.4 beta documentation @@ -31,7 +31,7 @@
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • API Reference
    • @@ -72,6 +72,18 @@ terminated (unless killed forcibly).

    programs that use RNS starting and terminating at different times, it will be advantageous to run a master RNS instance as a daemon for other programs to use on demand.

    +
    +
    +MTU = 500
    +

    The MTU that Reticulum adheres to, and will expect other peers to +adhere to. By default, the MTU is 500 bytes. In custom RNS network +implementations, it is possible to change this value, but doing so will +completely break compatibility with all other RNS networks. An identical +MTU is a prerequisite for peers to communicate in the same network.

    +

    Unless you really know what you are doing, the MTU should be left at +the default value.

    +
    +
    static should_allow_unencrypted()
    @@ -215,6 +227,21 @@ for addressable hashes and other purposes. Non-configurable.

    +
    +
    +static from_bytes(prv_bytes)
    +

    Create a new RNS.Identity instance from bytes of private key. +Can be used to load previously created and saved identities into Reticulum.

    +
    +
    Parameters
    +

    prv_bytes – The bytes of private a saved private key. HAZARD! Never use this to generate a new key by feeding random data in prv_bytes.

    +
    +
    Returns
    +

    A RNS.Identity instance, or None if the bytes data was invalid.

    +
    +
    +
    +
    static from_file(path)
    @@ -246,21 +273,6 @@ communication for the identity. Be very careful with this method.

    -
    -
    -static from_bytes(prv_bytes)
    -

    Create a new RNS.Identity instance from bytes of private key. -Can be used to load previously created and saved identities into Reticulum.

    -
    -
    Parameters
    -

    prv_bytes – The bytes of private a saved private key. HAZARD! Never not use this to generate a new key by feeding random data in prv_bytes.

    -
    -
    Returns
    -

    A RNS.Identity instance, or None if the bytes data was invalid.

    -
    -
    -
    -
    get_private_key()
    @@ -645,7 +657,7 @@ unless other app_data is specified in the announce method.

    Packet

    -class RNS.Packet(destination, data, packet_type=0, context=0, transport_type=0, header_type=0, transport_id=None, attached_interface=None, create_receipt=True)
    +class RNS.Packet(destination, data, create_receipt=True)

    The Packet class is used to create packet instances that can be sent over a Reticulum network. Packets to will automatically be encrypted if they are adressed to a RNS.Destination.SINGLE destination, @@ -660,11 +672,6 @@ destinations, reticulum will use ephemeral keys, and offers Forward Secr

  • destination – A RNS.Destination instance to which the packet will be sent.

  • data – The data payload to be included in the packet as bytes.

  • create_receipt – Specifies whether a RNS.PacketReceipt should be created when instantiating the packet.

    • -

  • type – Internal use by RNS.Transport. Defaults to RNS.Packet.DATA, and should not be specified.

    • -

  • context – Internal use by RNS.Transport. Ignore.

    • -

  • transport_type – Internal use by RNS.Transport. Ignore.

    • -

  • transport_id – Internal use by RNS.Transport. Ignore.

    • -

  • attached_interface – Internal use by RNS.Transport. Ignore.

    • @@ -709,11 +716,11 @@ destinations, reticulum will use ephemeral keys, and offers Forward Secr

    Packet Receipt

    -class RNS.PacketReceipt(packet)
    +class RNS.PacketReceipt

    The PacketReceipt class is used to receive notifications about RNS.Packet instances sent over the network. Instances -of this class should never be created manually, but always returned -from a the send() method of a RNS.Packet instance.

    +of this class are never created manually, but always returned from +the send() method of a RNS.Packet instance.

    get_status()
    @@ -774,17 +781,16 @@ from a the send() method of a

    Link

    -

    This class.

    +class RNS.Link(destination, established_callback=None, closed_callback=None) +

    This class is used to establish and manage links to other peers. When a +link instance is created, Reticulum will attempt to establish verified +connectivity with the specified destination.

    Parameters

    • destination – A RNS.Destination instance which to establish a link to.

      • -

    • established_callback – A function or method with the signature callback(link) to be called when the link has been established.

      • -

    • closed_callback – A function or method with the signature callback(link) to be called when the link is closed.

      • -

    • owner – Internal use by RNS.Transport, ignore this argument.

      • -

    • peer_pub_bytes – Internal use, ignore this argument.

      • -

    • peer_sig_pub_bytes – Internal use, ignore this argument.

      • +

    • established_callback – An optional function or method with the signature callback(link) to be called when the link has been established.

      • +

    • closed_callback – An optional function or method with the signature callback(link) to be called when the link is closed.

    @@ -834,6 +840,9 @@ thus preserved. This method can be used for authentication.

  • timeout – An optional timeout in seconds for the request. If None is supplied it will be calculated based on link RTT.

    • +
    Returns
    +

    A RNS.RequestReceipt instance if the request was sent, or False if it was not.

    +
    @@ -974,12 +983,73 @@ client application and throw an error message to the user.

    + +
    +

    Request Receipt

    +
    +
    +class RNS.RequestReceipt
    +

    An instance of this class is returned by the request method of RNS.Link +instances. It should never be instantiated manually. It provides methods to +check status, response time and response data when the request concludes.

    +
    +
    +get_request_id()
    +
    +
    Returns
    +

    The request ID as bytes.

    +
    +
    +
    + +
    +
    +get_status()
    +
    +
    Returns
    +

    The current status of the request, one of RNS.RequestReceipt.FAILED, RNS.RequestReceipt.SENT, RNS.RequestReceipt.DELIVERED, RNS.RequestReceipt.READY.

    +
    +
    +
    + +
    +
    +get_progress()
    +
    +
    Returns
    +

    The progress of a response being received as a float between 0.0 and 1.0.

    +
    +
    +
    + +
    +
    +get_response()
    +
    +
    Returns
    +

    The response as bytes if it is ready, otherwise None.

    +
    +
    +
    + +
    +
    +get_response_time()
    +
    +
    Returns
    +

    The response time of the request in seconds.

    +
    +
    +
    + +
    +

    Resource

    -class RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None, segment_index=1, original_hash=None, request_id=None, is_response=False)
    +class RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)

    The Resource class allows transferring arbitrary amounts of data over a link. It will automatically handle sequencing, compression, coordination and checksumming.

    @@ -988,14 +1058,10 @@ compression, coordination and checksumming.

    • data – The data to be transferred. Can be bytes or an open file handle. See the Filetransfer Example for details.

    • link – The RNS.Link instance on which to transfer the data.

      • -

    • advertise – Whether to automatically advertise the resource. Can be True or False.

      • -

    • auto_compress – Whether to auto-compress the resource. Can be True or False.

      • -

    • callback – A callable with the signature callback(resource). Will be called when the resource transfer concludes.

      • -

    • progress_callback – A callable with the signature callback(resource). Will be called whenever the resource transfer progress is updated.

      • -

    • segment_index – Internal use, ignore.

      • -

    • original_hash – Internal use, ignore.

      • -

    • is_request – Internal use, ignore.

      • -

    • is_response – Internal use, ignore.

      • +

    • advertise – Optional. Whether to automatically advertise the resource. Can be True or False.

      • +

    • auto_compress – Optional. Whether to auto-compress the resource. Can be True or False.

      • +

    • callback – An optional callable with the signature callback(resource). Will be called when the resource transfer concludes.

      • +

    • progress_callback – An optional callable with the signature callback(resource). Will be called whenever the resource transfer progress is updated.

    @@ -1013,8 +1079,8 @@ the resource advertisement it will begin transferring.

    -
    -progress()
    +
    +get_progress()
    Returns

    The current progress of the resource transfer as a float between 0.0 and 1.0.

    @@ -1030,7 +1096,9 @@ the resource advertisement it will begin transferring.

    class RNS.Transport
    -
    +

    Through static methods of this class you can interact with Reticulums +Transport system.

    +
    PATHFINDER_M = 128

    Maximum amount of hops that Reticulum will transport a packet.

    @@ -1120,6 +1188,7 @@ will announce it.

  • Packet
  • Packet Receipt
  • Link
    • +
  • Request Receipt
  • Resource
  • Transport
    • @@ -1167,7 +1236,7 @@ will announce it.

  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • API Reference
    • diff --git a/docs/manual/search.html b/docs/manual/search.html index 78dd5bf..dd0a948 100644 --- a/docs/manual/search.html +++ b/docs/manual/search.html @@ -5,7 +5,7 @@ - Search — Reticulum Network Stack 0.2.3 beta documentation + Search — Reticulum Network Stack 0.2.4 beta documentation @@ -29,7 +29,7 @@
  • index
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Search
    • @@ -85,7 +85,7 @@
  • index
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Search
    • diff --git a/docs/manual/searchindex.js b/docs/manual/searchindex.js index 4725bb4..fe89fe3 100644 --- a/docs/manual/searchindex.js +++ b/docs/manual/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["examples","gettingstartedfast","index","reference","understanding","whatis"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["examples.rst","gettingstartedfast.rst","index.rst","reference.rst","understanding.rst","whatis.rst"],objects:{"RNS.Destination":{announce:[3,1,1,""],app_and_aspects_from_name:[3,1,1,""],clear_default_app_data:[3,1,1,""],create_keys:[3,1,1,""],decrypt:[3,1,1,""],deregister_request_handler:[3,1,1,""],encrypt:[3,1,1,""],full_name:[3,1,1,""],get_private_key:[3,1,1,""],hash:[3,1,1,""],hash_from_name_and_identity:[3,1,1,""],load_private_key:[3,1,1,""],register_request_handler:[3,1,1,""],set_default_app_data:[3,1,1,""],set_link_established_callback:[3,1,1,""],set_packet_callback:[3,1,1,""],set_proof_requested_callback:[3,1,1,""],set_proof_strategy:[3,1,1,""],sign:[3,1,1,""]},"RNS.Identity":{CURVE:[3,2,1,""],KEYSIZE:[3,2,1,""],TRUNCATED_HASHLENGTH:[3,2,1,""],decrypt:[3,1,1,""],encrypt:[3,1,1,""],from_bytes:[3,1,1,""],from_file:[3,1,1,""],full_hash:[3,1,1,""],get_private_key:[3,1,1,""],get_public_key:[3,1,1,""],get_random_hash:[3,1,1,""],load_private_key:[3,1,1,""],load_public_key:[3,1,1,""],recall:[3,1,1,""],recall_app_data:[3,1,1,""],sign:[3,1,1,""],to_file:[3,1,1,""],truncated_hash:[3,1,1,""],validate:[3,1,1,""]},"RNS.Link":{CURVE:[3,2,1,""],ESTABLISHMENT_TIMEOUT_PER_HOP:[3,2,1,""],KEEPALIVE:[3,2,1,""],disable_encryption:[3,1,1,""],get_remote_identity:[3,1,1,""],identify:[3,1,1,""],inactive_for:[3,1,1,""],no_inbound_for:[3,1,1,""],no_outbound_for:[3,1,1,""],request:[3,1,1,""],set_packet_callback:[3,1,1,""],set_remote_identified_callback:[3,1,1,""],set_resource_callback:[3,1,1,""],set_resource_concluded_callback:[3,1,1,""],set_resource_started_callback:[3,1,1,""],set_resource_strategy:[3,1,1,""],teardown:[3,1,1,""]},"RNS.Packet":{ENCRYPTED_MDU:[3,2,1,""],PLAIN_MDU:[3,2,1,""],resend:[3,1,1,""],send:[3,1,1,""]},"RNS.PacketReceipt":{get_rtt:[3,1,1,""],get_status:[3,1,1,""],set_delivery_callback:[3,1,1,""],set_timeout:[3,1,1,""],set_timeout_callback:[3,1,1,""]},"RNS.Resource":{advertise:[3,1,1,""],cancel:[3,1,1,""],progress:[3,1,1,""]},"RNS.Reticulum":{should_allow_unencrypted:[3,1,1,""],should_use_implicit_proof:[3,1,1,""],transport_enabled:[3,1,1,""]},"RNS.Transport":{PATHFINDER_M:[3,2,1,""],deregister_announce_handler:[3,1,1,""],has_path:[3,1,1,""],hops_to:[3,1,1,""],register_announce_handler:[3,1,1,""],request_path:[3,1,1,""]},RNS:{Destination:[3,0,1,""],Identity:[3,0,1,""],Link:[3,0,1,""],Packet:[3,0,1,""],PacketReceipt:[3,0,1,""],Resource:[3,0,1,""],Reticulum:[3,0,1,""],Transport:[3,0,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute"},terms:{"0":[0,3,4,5],"00":4,"000":[4,5],"00000000":4,"00000100":4,"00000111":4,"01":4,"01010000":4,"05":0,"1":[0,3,4,5],"10":[0,4],"100":[0,4],"1000":[0,4],"1024":0,"11":4,"1200":4,"128":[3,4,5],"14":4,"141":[],"15":4,"151":4,"18":4,"180":4,"182":[],"2":[0,4],"20":[0,4],"205":[],"240":[4,5],"25":[0,5],"256":[3,4],"270":4,"2f":0,"3":[0,3,4,5],"323":[],"33":4,"34":4,"360":3,"3600":0,"383":3,"3e12fc71692f8ec47bc5":1,"4":4,"409":[],"430":4,"45":0,"477":[3,4],"5":[0,4],"500":[4,5],"512":3,"60":0,"62":[4,5],"7":4,"77":4,"8":0,"80":[3,4],"80e29bf7cccaf31431b3":4,"86":4,"868":4,"900":4,"95":4,"abstract":4,"break":[4,5],"byte":[0,3,4,5],"case":[1,4],"class":[0,2,5],"default":[0,3,4],"do":[0,1,4,5],"float":[0,3],"function":[0,2,3,5],"import":[0,1,4],"int":0,"long":[0,4],"new":[0,3,4],"public":[0,2,3],"return":[0,3],"short":4,"static":3,"throw":3,"true":[0,3],"try":[0,2],"while":[0,3,4,5],A:[0,3,4,5],And:0,As:[3,4,5],At:4,Be:3,But:4,By:[0,4],For:[3,4],IN:[0,3],If:[0,1,3,4,5],In:[0,1,4,5],It:[0,3,4,5],No:[4,5],On:0,One:3,Or:4,That:4,The:[0,1,2,3,5],There:[4,5],These:4,To:[0,4,5],Will:3,With:4,_:4,__:4,______:4,_______:4,________:4,________________:4,__init__:0,__main__:0,__name__:0,_exit:0,ab:0,abl:[0,3,4],about:[0,3,4],abov:[1,4],accept:[3,4],accept_al:[0,3],accept_app:3,accept_non:3,access:[3,4],accord:4,accordingli:0,acheiv:4,achiev:[3,4],acknowledg:5,act:[3,4],action:0,activ:[0,3,4],actor:4,actual:[0,1,4],ad:[0,3,4,5],add:0,add_argu:0,addit:[4,5],addr1:4,addr2:4,address:[0,3,4,5],adress:[0,3,5],advantag:3,advertis:[0,3],advis:4,ae:[4,5],after:[0,4],again:[1,4],against:4,agent:4,agnost:4,agnostic:4,aim:[2,4],aliv:[3,4],all:[0,2,3,4,5],allow:[0,3,4,5],allow_al:[0,3],allow_list:3,allow_non:3,allowed_list:3,almost:4,along:[3,4],alreadi:[0,4],also:[0,3,4,5],alter:4,altern:0,although:5,alwai:[3,4],amateur:5,amount:[3,4,5],an:[0,1,3,4,5],ani:[0,1,3,4,5],announc:[2,3],announce_handl:0,announced_ident:[0,3],announceloop:0,announcesampl:0,anonym:[3,4],anoth:[1,3,4],answer:4,anyon:[0,3,4],anyth:4,anywher:0,apart:4,api:[1,2,4,5],app:[0,3,4],app_and_aspects_from_nam:3,app_data:[0,3],app_nam:[0,3],app_timeout:0,append:[0,4],appli:4,applic:[0,3,4],approv:4,approxim:4,ar:[0,3,4,5],arbitrari:[3,4],arbritrari:5,area:5,arg:0,argon:0,argpars:0,argument:[0,3],argumentpars:0,around:4,arriv:[0,4],ask:[0,3],aspect:[0,3,4],aspect_filt:[0,3],assign:4,associ:[1,3,4],assum:4,asymmetr:5,attached_interfac:3,attribut:3,audit:5,authent:[3,4,5],author:4,auto:[3,4],auto_compress:3,autoconfigur:5,autom:4,automat:[0,3,4,5],autonom:4,autoomat:0,avail:[0,4,5],averag:4,avoid:4,awai:[0,4],awar:4,ax:5,b:0,back:[0,4,5],band:4,bandwidth:[4,5],bare:0,barrier:4,base:[2,3,4,5],basi:[3,4,5],basic:[0,1,2],baud:4,becaus:4,becki:0,becom:0,been:[0,3,4,5],befor:[0,3,4],begin:[0,3],begun:3,behind:4,being:4,belief:4,below:1,best:[1,4,5],beta:5,between:[0,3,4],bgp:4,bi:4,bidirect:4,binari:[0,2],bit:[3,4,5],blob:[0,4],both:[3,4,5],bp:4,briefli:4,broadcast:[2,3,4],broadcast_destin:0,broadcastloop:0,bug:5,build:[0,4,5],built:[1,4,5],bundl:0,c:[0,4],cad:4,calcul:[3,4],call:[0,3,4,5],callabl:3,callback:[0,3],can:[0,1,2,3,4],cancel:3,cannot:0,capac:4,carambola:0,care:[3,4,5],carri:[3,4],carrier:5,caveat:2,cb:4,cbc:5,cd:1,censor:4,censorship:4,central:4,certain:[0,4],challeng:4,chang:[0,1,4,5],channel:[0,4,5],channelarg:0,chapter:[1,4],charact:0,characterist:4,cheap:4,check:0,checksum:[3,5],choos:0,chose:4,chunk:0,ciphertext:3,ciphertext_token:3,cl:0,clear:[0,3,4],clear_default_app_data:3,clear_screen:0,client:[0,1,3],client_connect:0,client_disconnect:0,client_ident:0,client_loop:0,client_packet_receiv:0,client_request:0,clone:1,close:[0,3],closed_callback:3,closer:4,cluster:4,code:[0,4],com:[0,1],combin:4,come:4,command:[0,1],common:4,commun:[0,1,3,4,5],compat:4,complet:[0,1,3,4,5],compon:4,compos:4,compress:[0,3,4],comput:[1,4],concaten:3,concept:4,conclud:[0,3],concurr:4,condit:4,config:[0,1],configarg:0,configdir:3,configpath:0,configur:[0,3,4,5],confirm:[4,5],connect:[0,3,4,5],consequ:4,consid:[4,5],consist:4,constant:[3,4],construct:4,contact:4,contain:[0,3,4],content:[],context:[3,4],control:[0,3,4],conveni:0,convent:0,coordin:[3,4,5],core:[4,5],correct:[0,4],correctli:0,correspond:4,cost:[4,5],could:[0,3,4,5],count:4,counter:0,cover:5,cpu:0,creat:[0,1,3,4],create_kei:3,create_receipt:[0,3],creation:4,creator:4,critic:4,cryptograph:5,cryptographi:[1,4,5],ctrl:0,cull:3,current:[0,2,3,4],current_download:0,current_filenam:0,curv:[3,4,5],curve25519:[3,4,5],custom:4,d:4,daemon:3,dai:4,data:[0,3,4,5],date:0,debian:4,debug:3,decai:4,decid:[3,4],decod:0,decrypt:[3,4],dedic:4,def:0,default_timeout:[],defin:[0,4],definit:4,delai:4,deliv:[0,3],deliveri:[0,3,5],demand:3,demonstr:0,depend:1,deploi:4,deregist:3,deregister_announce_handl:3,deregister_request_handl:3,deriv:[4,5],describ:[3,4],descript:0,design:[4,5],desir:[0,4],destin:[0,1,2],destination_1:0,destination_2:0,destination_clos:0,destination_hash:[0,3],destination_hexhash:0,detail:[0,2,3],detect:0,determin:[3,4],develop:[2,4,5],devic:[2,3,4],dh:3,did:0,differ:[0,1,3,4,5],diffi:[4,5],digit:[4,5],dir:0,direct:[0,3,4],directli:[3,4,5],directori:0,disable_encrypt:3,disappear:3,discard:4,disconnect:0,discoveri:4,discuss:4,disk:[0,3],displai:[0,4],distanc:4,distinct:4,distribut:[0,3,4],divmod:0,document:4,doe:[0,2,3,4],don:[0,1],done:[0,4],dot:4,down:0,downgrad:3,download:0,download_began:0,download_conclud:0,download_finish:0,download_start:0,download_tim:0,driver:5,drop:4,duplex:[4,5],e:0,each:[0,4],earlier:4,eas:4,easi:[4,5],easiest:[1,4],easili:[4,5],ecdh:[4,5],echo:[1,2],echo_destin:0,echo_request:0,ed25519:[4,5],effici:[0,4,5],ei:0,either:4,elif:0,ellipt:[3,4,5],els:[0,4],emploi:4,emptor:2,enabl:3,enable_transport:4,encapsul:5,encod:0,encrypt:[0,1,3,4,5],encrypted_mdu:3,encryptionless:3,end:[0,3,4,5],endpoint:[0,3,4],engin:4,ensur:4,enter:0,entir:4,entiti:4,entri:[0,4],enumer:0,environ:4,environment:4,environmentlogg:4,ephemer:[3,4,5],equal:4,equip:4,equl:[],error:[0,3],essenti:4,establish:[0,3,5],established_callback:3,establishment_timeout_per_hop:3,ethernet:[4,5],even:[4,5],everi:[0,3,4],everyon:4,everyth:[0,4],exact:4,exactli:[3,4],exampl:[1,2,3,4,5],example_util:0,exampleannouncehandl:0,exce:0,except:[0,4],exchang:[3,4,5],execut:[0,3],exhaust:4,exist:[0,4,5],exit:[0,1,3],exit_handl:0,expand:4,expect:[0,4],experi:[1,4],experiment:5,explain:3,explan:4,explicit:3,explicitli:3,explor:[0,4,5],expos:3,extend:[0,4],extern:[3,5],extrem:5,fa7ddfab5213f916dea:4,face:1,fact:[4,5],fail:[0,3],failed_callback:[0,3],fals:[0,3],far:4,fast:2,featur:[4,5],feed:3,feedback:0,fernet:5,few:[4,5],field:4,file:[0,1,3,4,5],file_resourc:0,file_s:0,filelist:0,filelist_data:0,filelist_receiv:0,filelist_timeout_job:0,filenam:0,filetransf:[1,2,3],filter:[0,4],find:4,firmwar:4,first:[0,3,4],fit:0,five:0,fix:4,flag:[3,4],flush:0,folder:1,follow:[0,4,5],forcibl:3,foremost:5,form:[3,4],format:[0,2,5],forth:0,forward:[3,4,5],found:[0,1,4],free:5,frequenc:4,friendli:5,from:[0,1,3,4,5],from_byt:3,from_fil:3,fromhex:0,fruit:0,full:[0,3,4],full_hash:3,full_nam:3,fulli:[4,5],funcion:3,fundament:4,further:[1,2],futur:[3,4],g:0,ga:0,gatekeep:4,gener:[0,3,4,5],generalis:5,get:[0,2,3,5],get_private_kei:3,get_public_kei:3,get_random_hash:[0,3],get_remote_ident:[0,3],get_rtt:[0,3],get_statu:3,gi:0,gigabyt:5,git:1,github:[0,1],give:4,given:4,global:[0,5],go:[0,1,4],goal:2,good:4,got:0,got_respons:0,govern:4,grape:0,great:4,greater:4,group:[3,4],guarante:4,guid:[1,3,4],h:[1,4],ha:[0,3,4,5],had:4,half:[4,5],hand:0,handheld:4,handl:[0,3,4,5],handler:[0,3],happen:[0,3],hardwar:[3,4,5],has_path:[0,3],hasattr:0,hash:[0,1,3,4],hash_from_name_and_ident:3,hashmap:0,have:[0,1,3,4],hazard:3,header:4,header_1:4,header_2:4,header_typ:3,hear:4,heard:[3,4],helium:0,hellman:[4,5],help:[0,4,5],here:[0,4],hexadecim:[0,4],high:[4,5],higher:[4,5],highli:4,hint:0,hit:0,hmac:5,hoc:5,hold:[3,4],hop:[3,4,5],hops_to:3,host:[0,4,5],hour:0,how:[0,4,5],howev:4,http:[0,1],human:[0,3],i:0,id:4,idea:4,ident:[0,2],identif:[2,5],identifi:[0,3,4],identify:4,identifyexampl:0,ie:[],ignor:[3,4],immedi:1,impact:4,implement:[0,4,5],implicit:[3,4],inactive_for:3,inbound:3,includ:[0,3,4],incom:[0,3],incompat:[3,4],indefinit:4,independ:3,independt:5,index:[0,2],indirectli:4,individu:4,inevit:4,infer:4,info:[3,4],inform:[0,1,2,3,4],infrastructur:4,ingo:3,initi:[0,3,4],initialis:[0,3],input:0,insert:4,instal:1,instanc:[0,3],instanti:3,instead:[0,4],integr:4,intend:4,intention:4,inter:3,interact:[0,4],interest:4,interfac:[0,2,3,4],intern:[3,4],internet:[4,5],interv:3,intiat:0,introduc:4,introduct:2,intuit:5,invalid:[0,3],investig:4,ip:[4,5],is_request:3,is_respons:3,isdir:0,isfil:0,ism:4,its:[3,4],itself:[2,3,4],iv:5,job:0,join:[0,4],just:[0,4,5],k:0,kbp:4,keep:[0,3,4,5],keepal:[3,4],kei:[0,2,3,5],kept:[3,4],kernel:5,keyboardinterrupt:0,keyerror:3,keypair:4,keysiz:3,ki:0,kill:3,kilomet:4,kind:4,know:[0,3,4],knowledg:4,known:[0,3,4],krypton:0,lack:4,laid:4,larg:[0,4],larger:4,last:[0,3],last_unit:0,latenc:[4,5],later:0,latest:[0,1],latest_client_link:0,launch:1,lavg:4,layer:[4,5],lead:4,learn:[0,4],least:[4,5],leav:4,ledger:4,left:4,len:0,length:[0,3],less:[4,5],let:[0,4],level:4,librari:1,licens:4,light:4,like:[1,3,4],limit:4,line:[0,1,4,5],link:[2,5],link_clos:0,link_establish:0,linkexampl:0,linux:4,list:[0,3,4],list_deliv:0,list_fil:0,list_packet:0,list_receipt:0,list_timeout:0,listdir:0,listen:[0,4],littl:4,lki:4,lkr:4,ll:[0,1,5],ln:1,load:[0,3],load_private_kei:3,load_public_kei:3,local:[0,3,4,5],locat:4,log:0,log_error:0,log_info:0,loglevel:0,longer:[0,4],look:[0,1,4],loop:0,lora:[4,5],lorawan:4,lot:4,low:[4,5],lxmf:1,m:[0,4],mac:4,machin:4,made:[3,4],mai:4,main:0,maintain:4,make:[1,4],malici:4,manag:3,mani:[0,4,5],manipul:4,manual:[0,1,3],mark:4,markqvist:[0,1],master:[0,3],match:0,maximum:[3,4],mcu:4,mdu:0,mean:4,measur:4,mechan:2,medium:[4,5],memori:4,mention:4,menu:0,menu_mod:0,mesh:5,messag:[0,1,3,4],messeng:4,metavar:0,method:[0,3,4],methodolog:4,mhz:4,mi:0,microcontrol:4,microwav:4,might:4,millisecond:0,mind:5,minim:[2,4],minimalsampl:0,minimum:[0,4],minut:[0,4],mode:[0,1,4,5],modem:[3,4,5],modul:[0,4,5],moment:[4,5],monitor:4,moon:0,more:[3,4,5],most:[1,4,5],motiv:2,move:1,mtu:[4,5],much:4,multi:[4,5],multilater:4,multipl:[0,4],multipoint:4,must:[0,3,4],my:4,n:0,name:[0,3],namespac:0,nano:1,narg:0,necessari:[1,3,4],necessarili:4,need:[0,2,4,5],neglig:4,neither:4,neon:0,network:[0,1,3,4,5],never:3,newer:4,newest:4,newli:4,next:[1,4],nicknam:4,no_inbound_for:3,no_outbound_for:3,nobl:0,noble_ga:0,noble_gas:0,node:[2,5],nomad:1,non:[3,4],none:[0,3,4],normal:0,notat:4,note:[0,4],noth:5,notic:4,notif:[0,3],now:[0,1,4],nt:0,num:0,number:[0,3,4],object:3,obtain:4,occur:5,off:[4,5],offer:[2,3,4],often:4,oganesson:0,old:4,onc:[0,3,4,5],one:[0,3,4,5],onli:[0,3,4,5],onlin:4,open:[0,3,4,5],openmodem:5,oper:[3,4,5],opt:4,optic:5,option:[0,1,3],orient:4,origin:[0,4],original_hash:3,os:[0,4,5],ospf:4,other:[3,4],otherwis:[3,4],our:[0,4],out:[0,3,4,5],outbound:3,outgo:[0,3,4],outlin:[1,4],outward:4,over:[0,3,4,5],overal:4,overcom:4,overhead:4,overrid:0,overview:4,own:[0,1,3,4],owner:3,p:[0,4],pack:0,packb:0,packet:[0,2,5],packet_callback:0,packet_deliv:0,packet_receipt:[0,3],packet_timed_out:0,packet_typ:3,packetreceipt:[0,3],pad:5,page:[2,4],pair:4,palm:0,paramet:3,pars:0,parse_arg:0,parser:0,part:[0,4],particip:[2,4],pass:[0,3,4],path:[0,1,3,4],path_respons:3,pathfind:[],pathfinder_m:3,pattern:4,payload:[3,4],peach:0,peer:[0,3,4],peer_pub_byt:3,peer_sig_pub_byt:3,peopl:4,per:[3,4,5],percent:0,perfect:4,perform:[0,4],period:4,persecut:4,person:4,pet:0,philosophi:4,physic:4,pi:[0,4,5],piec:4,ping:1,pip3:1,pip:1,pkcs7:5,place:4,plain:[0,3,4],plain_mdu:3,plaintext:[0,3],platform:4,pleas:[0,5],plenti:4,plu:4,pmr:4,point:4,pomelo:0,port:[4,5],possess:4,possibl:[4,5],potenti:[0,4],practic:[4,5],pre:[3,4],predict:4,prefer:4,prepar:0,presenc:3,preserv:3,press:0,pretend:4,pretti:4,prettyhexrep:0,previou:0,previous:[3,4],primari:4,principl:[4,5],print:0,print_filelist:0,print_help:0,print_menu:0,prioriti:4,prioritis:2,privaci:5,privat:[3,4,5],probabl:[0,4,5],procedur:4,process:[1,3,4],product:3,program:[0,2,3,4],program_setup:0,programm:4,programmat:4,progress:[0,3,5],progress_callback:3,project:1,prompt:0,proof:[0,3,4],proof_requested_callback:3,proof_strategi:3,propag:4,properti:3,protocol:[1,2,5],prove:[0,4],prove_al:[0,3],prove_app:3,prove_non:3,proven:[3,4],provid:[0,1,2,3,4,5],prv_byte:3,pub_byt:3,public_inform:0,purchas:[4,5],purg:3,purpos:[3,4],purposefulli:4,put:0,py:[0,1],pyseri:1,python3:1,python:[4,5],q:0,queri:0,queue:4,quinc:0,quit:0,r:[0,4],radio:[3,4,5],radiu:4,radon:0,rais:[0,3],rand:4,randint:0,random:[0,3,4],random_text_gener:0,randomli:[0,4],rang:[0,4,5],raspberri:[4,5],rate:0,rb:0,re:[0,3,4],reach:2,reachabl:[0,3,4],read:[0,1,4],readabl:[0,3,4],readi:[0,1],readili:5,real:5,reason:4,reassembl:4,recal:[0,3],recall_app_data:3,recap:4,receipt:[0,2,4],receiv:[0,3,4],received_announc:[0,3],recip:1,recipi:4,recommend:[0,4],reconstruct:4,record:4,recreat:4,refer:[0,1,2],regard:4,regist:[0,3],register_announce_handl:[0,3],register_request_handl:[0,3],rel:[4,5],releas:[1,4],relev:[0,3],reli:4,reliabl:[4,5],rem:0,remain:4,rememb:4,remot:[0,3,5],remote_ident:[0,3],remote_identifi:0,remote_identity_hash:[],remote_p:0,remotesensor:4,repeat:1,replac:[1,4],repli:0,replic:4,reply_data:0,reply_text:0,repositori:1,repres:4,represent:[0,4],request:[2,3,4],request_destin:0,request_fail:0,request_id:[0,3],request_packet:0,request_path:[0,3],request_receipt:[0,3],request_receiv:0,requested_at:[0,3],requestexampl:0,requir:[0,4,5],research:5,resend:3,reserv:4,resili:5,resourc:[0,2],resource_callback:3,resource_sending_conclud:0,resource_strategi:3,respond:[0,3],respons:[2,3],response_callback:[0,3],response_gener:[0,3],rest:5,result:[0,4],reticulum:0,retransmiss:4,retransmit:4,retri:4,reveal:[3,4],review:5,right:[],rn:[0,1,3],rnode:[4,5],robot:4,rotat:4,round:[0,3],rout:[3,4,5],rprogress:0,rsa:[],rtt:[0,3,4],rttstring:0,rule:4,run:[0,1,3,4,5],runtim:4,rw:4,s:[0,1,4,5],said:4,same:[1,3,4],satisfi:4,save:[3,4],save_error:0,saved_filenam:0,scenario:[1,4],screen:0,search:2,second:[0,3,4,5],secreci:[3,4,5],section:4,secur:[4,5],see:[0,3,4],seen:4,segment_index:3,select:0,self:[0,5],send:[0,3,4],sender:[0,4],sendig:0,sensibl:1,sensor:4,sent:[0,3,4],sentiment:4,separ:4,sequenc:[0,3,4,5],serial:[4,5],serv:[0,4],serve_path:0,server:[0,1],server_callback:0,server_destin:0,server_fil:0,server_ident:0,server_link:0,server_loop:0,server_packet_receiv:0,session:4,set:[0,3,4,5],set_default_app_data:3,set_delivery_callback:[0,3],set_link_closed_callback:0,set_link_established_callback:[0,3],set_packet_callback:[0,3],set_proof_requested_callback:3,set_proof_strategi:[0,3],set_remote_identified_callback:[0,3],set_resource_callback:3,set_resource_concluded_callback:[0,3],set_resource_started_callback:[0,3],set_resource_strategi:[0,3],set_timeout:[0,3],set_timeout_callback:[0,3],setdaemon:0,setup:[0,2],sever:3,sha256:5,sha:[3,4],shall:4,share:[1,3,4],shelf:[4,5],shop:0,shortest:4,should:[0,3,4,5],should_allow_unencrypt:3,should_quit:0,should_use_implicit_proof:3,shown:0,side:5,sign:[3,4],signatur:[3,4,5],similar:5,simpl:[0,4,5],simplest:4,simpli:[0,1,4],simplic:4,sinc:[0,3,4],singl:[0,3,4],singular:4,situat:4,size:[0,3,4],size_str:0,sleep:0,slice:0,slow:[0,4],small:[0,4],so:[0,1,4,5],softwar:[4,5],some:[0,1,4],someth:4,somethign:0,soon:3,sort:4,sourc:[0,1,4,5],space:[0,5],span:4,special:4,specif:[0,2,3,5],specifi:[0,3],spectrum:4,split:0,sponsor:5,stabl:[4,5],stack:[0,1,4,5],stage:4,stai:0,standard:4,start:[0,2,3,4],startup:0,state:0,station:4,statist:0,statu:[0,2,3,4],stdout:0,step:1,still:[0,4],stock:0,stop:5,store:[0,4],store_tru:0,str:0,strategi:3,stream:4,strength:5,strictli:4,string:[0,3],structur:4,subject:4,subsequ:4,successful:3,successfulli:0,sucessfulli:4,suffic:4,suffici:4,suffix:0,suit:[1,4],suitabl:[0,4],suppli:[3,4],support:[0,2,4],sy:0,symlink:1,symmetr:[3,4],system:[0,2,3,5],t:[0,1,4],tabl:4,take:[0,1,4,5],taken:[0,4],tangerin:0,target:0,tcp:[4,5],tdata:0,teardown:[0,3],teardown_reason:0,teffect:0,tell:0,temperatur:4,ten:4,term:4,termin:3,terminolog:4,test:4,text:[0,4],tfile:0,than:[0,4],thei:[0,3,4],them:[0,4],thereaft:4,therefor:[4,5],thi:[0,1,2,3,4],though:4,thourough:5,thread:0,three:4,through:[4,5],throughout:4,throughput:[4,5],thu:[3,4],ti:[0,4],time:[0,1,3,4],timeout:[0,3],timeout_callback:[],timeoutarg:0,timestr:0,tnc:[3,5],to_fil:3,todai:4,todo:[],togeth:4,token:[3,4],too:[0,4],tool:5,top:4,topic:4,topolog:4,total:[4,5],total_s:0,touch:5,toward:[0,4],traffic:[0,3,4],tramsit:[],transceiv:[4,5],transfer:[0,3,4,5],transfer_s:0,transmiss:4,transmit:[0,4],transpar:4,transport:[0,2,5],transport_en:3,transport_id:3,transport_typ:3,travers:4,treat:4,tri:0,trip:[0,3],trivial:5,truli:4,truncat:[3,4],truncated_hash:3,truncated_hashlength:3,trust:4,trustless:[4,5],ttime:0,ttransfer:0,tunnel:[4,5],tupl:3,two:[0,4],type:[0,2,3],typeerror:3,udp:[4,5],umsgpack:0,uncencrypt:0,underli:5,understand:[1,2],unencrypt:[0,3,4],unequivoc:4,unforg:5,unidentifi:0,uninterest:0,uniqu:[4,5],unit:0,unknown:[0,3,4],unless:[1,3,4],unlicens:4,unpack:0,unpackb:0,unsupport:3,until:[0,3,4],unwant:4,up:[0,4,5],updat:[0,3],upon:[0,4],upset:0,urandom:5,us:[0,2,3,4],usabl:4,usag:[],usb:[4,5],useabl:4,user:[0,1,3,4],user_input:0,userland:5,utf:0,util:[0,1,4],utilis:[4,5],valid:[0,3,4],valu:4,valueerror:[0,3],variabl:0,varieti:[4,5],variou:[0,4],ve:1,vendor:0,veri:[3,4,5],verif:[3,4],verifi:[0,4],versa:5,version:3,vhf:4,via:[1,4],vice:5,view:4,visibl:0,wa:[0,3,4,5],wai:[0,1,4],wait:[0,4],want:[0,1,4,5],warrant:5,wb:0,we:[0,4],well:[3,4,5],went:0,what:[0,1,2,3,4],whatev:[3,4],when:[0,1,3,4],whenev:3,where:[2,3,4],whereupon:4,whether:[0,3,4],which:[0,1,3,4],who:4,wide:[4,5],wifi:[4,5],wildcard:0,window:4,wire:[4,5],wish:4,within:[0,3,4],won:0,work:[4,5],world:5,would:4,write:[0,3],written:4,wrong:0,x25519:[3,4,5],x:4,xenon:0,y:0,ye:4,year:4,yet:[0,4],yi:0,you:[0,1,2,3,4,5],your:[0,1,4,5],yourself:[4,5],z:0,zero:3,zi:0},titles:["Examples","Getting Started Fast","Reticulum Network Stack Manual","API Reference","Understanding Reticulum","What is Reticulum?"],titleterms:{"1":[],"2":[],"class":3,"function":4,"public":4,"try":1,The:4,announc:[0,4],api:3,base:1,basic:4,binari:4,broadcast:0,can:5,caveat:5,current:5,deliveri:[],destin:[3,4],detail:4,develop:1,devic:5,doe:5,echo:0,emptor:5,establish:4,exampl:0,fast:1,filetransf:0,format:4,further:4,get:[1,4],goal:4,ident:[3,4],identif:0,indic:2,interfac:5,introduct:4,kei:4,link:[0,3,4],manual:2,mechan:4,minim:0,motiv:4,name:4,network:2,node:4,offer:5,packet:[3,4],particip:1,pathfind:[],prioritis:4,program:1,protocol:4,proven:[],reach:4,receipt:3,refer:[3,4],request:0,resourc:[3,4],respons:0,reticulum:[1,2,3,4,5],setup:4,specif:4,stack:2,start:1,statu:5,step:[],support:5,system:4,tabl:2,transport:[3,4],type:[4,5],understand:4,us:[1,5],what:5,where:5}}) \ No newline at end of file +Search.setIndex({docnames:["examples","gettingstartedfast","index","reference","understanding","whatis"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["examples.rst","gettingstartedfast.rst","index.rst","reference.rst","understanding.rst","whatis.rst"],objects:{"RNS.Destination":{announce:[3,1,1,""],app_and_aspects_from_name:[3,1,1,""],clear_default_app_data:[3,1,1,""],create_keys:[3,1,1,""],decrypt:[3,1,1,""],deregister_request_handler:[3,1,1,""],encrypt:[3,1,1,""],full_name:[3,1,1,""],get_private_key:[3,1,1,""],hash:[3,1,1,""],hash_from_name_and_identity:[3,1,1,""],load_private_key:[3,1,1,""],register_request_handler:[3,1,1,""],set_default_app_data:[3,1,1,""],set_link_established_callback:[3,1,1,""],set_packet_callback:[3,1,1,""],set_proof_requested_callback:[3,1,1,""],set_proof_strategy:[3,1,1,""],sign:[3,1,1,""]},"RNS.Identity":{CURVE:[3,2,1,""],KEYSIZE:[3,2,1,""],TRUNCATED_HASHLENGTH:[3,2,1,""],decrypt:[3,1,1,""],encrypt:[3,1,1,""],from_bytes:[3,1,1,""],from_file:[3,1,1,""],full_hash:[3,1,1,""],get_private_key:[3,1,1,""],get_public_key:[3,1,1,""],get_random_hash:[3,1,1,""],load_private_key:[3,1,1,""],load_public_key:[3,1,1,""],recall:[3,1,1,""],recall_app_data:[3,1,1,""],sign:[3,1,1,""],to_file:[3,1,1,""],truncated_hash:[3,1,1,""],validate:[3,1,1,""]},"RNS.Link":{CURVE:[3,2,1,""],ESTABLISHMENT_TIMEOUT_PER_HOP:[3,2,1,""],KEEPALIVE:[3,2,1,""],disable_encryption:[3,1,1,""],get_remote_identity:[3,1,1,""],identify:[3,1,1,""],inactive_for:[3,1,1,""],no_inbound_for:[3,1,1,""],no_outbound_for:[3,1,1,""],request:[3,1,1,""],set_packet_callback:[3,1,1,""],set_remote_identified_callback:[3,1,1,""],set_resource_callback:[3,1,1,""],set_resource_concluded_callback:[3,1,1,""],set_resource_started_callback:[3,1,1,""],set_resource_strategy:[3,1,1,""],teardown:[3,1,1,""]},"RNS.Packet":{ENCRYPTED_MDU:[3,2,1,""],PLAIN_MDU:[3,2,1,""],resend:[3,1,1,""],send:[3,1,1,""]},"RNS.PacketReceipt":{get_rtt:[3,1,1,""],get_status:[3,1,1,""],set_delivery_callback:[3,1,1,""],set_timeout:[3,1,1,""],set_timeout_callback:[3,1,1,""]},"RNS.RequestReceipt":{get_progress:[3,1,1,""],get_request_id:[3,1,1,""],get_response:[3,1,1,""],get_response_time:[3,1,1,""],get_status:[3,1,1,""]},"RNS.Resource":{advertise:[3,1,1,""],cancel:[3,1,1,""],get_progress:[3,1,1,""]},"RNS.Reticulum":{MTU:[3,2,1,""],should_allow_unencrypted:[3,1,1,""],should_use_implicit_proof:[3,1,1,""],transport_enabled:[3,1,1,""]},"RNS.Transport":{PATHFINDER_M:[3,2,1,""],deregister_announce_handler:[3,1,1,""],has_path:[3,1,1,""],hops_to:[3,1,1,""],register_announce_handler:[3,1,1,""],request_path:[3,1,1,""]},RNS:{Destination:[3,0,1,""],Identity:[3,0,1,""],Link:[3,0,1,""],Packet:[3,0,1,""],PacketReceipt:[3,0,1,""],RequestReceipt:[3,0,1,""],Resource:[3,0,1,""],Reticulum:[3,0,1,""],Transport:[3,0,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute"},terms:{"0":[0,3,4,5],"00":4,"000":[4,5],"00000000":4,"00000100":4,"00000111":4,"01":4,"01010000":4,"05":0,"1":[0,3,4,5],"10":[0,4],"100":[0,4],"1000":[0,4],"1024":0,"11":4,"1200":4,"128":[3,4,5],"14":4,"141":[],"15":4,"151":4,"18":4,"180":4,"182":[],"2":[0,4],"20":[0,4],"205":[],"211":[],"237":[4,5],"240":[],"25":[0,5],"256":[3,4],"270":4,"2f":0,"3":[0,3,4,5],"323":[],"33":4,"34":4,"360":3,"3600":0,"383":3,"3e12fc71692f8ec47bc5":1,"4":4,"409":[],"430":4,"45":0,"477":[3,4],"5":[0,4],"500":[3,4,5],"512":3,"60":0,"62":[4,5],"7":4,"77":4,"8":0,"80":[3,4],"80e29bf7cccaf31431b3":4,"83":4,"86":[],"868":4,"900":4,"95":4,"abstract":4,"break":[3,4,5],"byte":[0,3,4,5],"case":[1,4],"class":[0,2,5],"default":[0,3,4],"do":[0,1,3,4,5],"float":[0,3],"function":[0,2,3,5],"import":[0,1,4],"int":0,"long":[0,4],"new":[0,3,4],"public":[0,2,3],"return":[0,3],"short":4,"static":3,"throw":3,"true":[0,3],"try":[0,2],"while":[0,3,4,5],A:[0,3,4,5],And:0,As:[3,4,5],At:4,Be:3,But:4,By:[0,3,4],For:[3,4],IN:[0,3],If:[0,1,3,4,5],In:[0,1,3,4,5],It:[0,3,4,5],No:[4,5],On:0,One:3,Or:4,That:4,The:[0,1,2,3,5],There:[4,5],These:4,To:[0,4,5],Will:3,With:4,_:4,__:4,______:4,_______:4,________:4,________________:4,__init__:0,__main__:0,__name__:0,_exit:0,ab:0,abl:[0,3,4],about:[0,3,4],abov:[1,4],absolut:[],accept:[3,4],accept_al:[0,3],accept_app:3,accept_non:3,access:[3,4],accord:4,accordingli:0,acheiv:4,achiev:[3,4],acknowledg:5,act:[3,4],action:0,activ:[0,3,4],actor:4,actual:[0,1,4],ad:[0,3,4,5],add:0,add_argu:0,addit:[4,5],addr1:4,addr2:4,address:[0,3,4,5],adher:3,adress:[0,3,5],advantag:3,advertis:[0,3],advis:4,ae:[4,5],after:[0,4],again:[1,4],against:4,agent:4,agnost:4,agnostic:4,aim:[2,4],aliv:[3,4],all:[0,2,3,4,5],allow:[0,3,4,5],allow_al:[0,3],allow_list:3,allow_non:3,allowed_list:3,almost:4,along:[3,4],alreadi:[0,4],also:[0,3,4,5],alter:4,altern:0,although:5,alwai:[3,4],amateur:5,amount:[3,4,5],an:[0,1,3,4,5],ani:[0,1,3,4,5],announc:[2,3],announce_handl:0,announced_ident:[0,3],announceloop:0,announcesampl:0,anonym:[3,4],anoth:[1,3,4],answer:4,anyon:[0,3,4],anyth:4,anywher:0,apart:4,api:[1,2,4,5],app:[0,3,4],app_and_aspects_from_nam:3,app_data:[0,3],app_nam:[0,3],app_timeout:0,append:[0,4],appli:4,applic:[0,3,4],approv:4,approxim:4,ar:[0,3,4,5],arbitrari:[3,4],arbritrari:5,area:5,arg:0,argon:0,argpars:0,argument:[0,3],argumentpars:0,around:4,arriv:[0,4],ask:[0,3],aspect:[0,3,4],aspect_filt:[0,3],assign:4,associ:[1,3,4],assum:4,asymmetr:5,attached_interfac:[],attempt:3,attribut:3,audit:5,authent:[3,4,5],author:4,auto:[3,4],auto_compress:3,autoconfigur:5,autom:4,automat:[0,3,4,5],autonom:4,autoomat:0,avail:[0,4,5],averag:4,avoid:4,awai:[0,4],awar:4,ax:5,b:0,back:[0,4,5],band:4,bandwidth:[4,5],bare:0,barrier:4,base:[2,3,4,5],basi:[3,4,5],basic:[0,1,2],baud:4,becaus:4,becki:0,becom:0,been:[0,3,4,5],befor:[0,3,4],begin:[0,3],begun:3,behind:4,being:[3,4],belief:4,below:1,best:[1,4,5],beta:5,between:[0,3,4],bgp:4,bi:4,bidirect:4,binari:[0,2],bit:[3,4,5],blob:[0,4],both:[3,4,5],bp:4,briefli:4,broadcast:[2,3,4],broadcast_destin:0,broadcastloop:0,bug:5,build:[0,4,5],built:[1,4,5],bundl:0,c:[0,4],cad:4,calcul:[3,4],call:[0,3,4,5],callabl:3,callback:[0,3],can:[0,1,2,3,4],cancel:3,cannot:0,capac:4,carambola:0,care:[3,4,5],carri:[3,4],carrier:5,caveat:2,cb:4,cbc:5,cd:1,censor:4,censorship:4,central:4,certain:[0,4],challeng:4,chang:[0,1,3,4,5],channel:[0,4,5],channelarg:0,chapter:[1,4],charact:0,characterist:4,cheap:4,check:[0,3],checksum:[3,5],choos:0,chose:4,chunk:0,ciphertext:3,ciphertext_token:3,cl:0,clear:[0,3,4],clear_default_app_data:3,clear_screen:0,client:[0,1,3],client_connect:0,client_disconnect:0,client_ident:0,client_loop:0,client_packet_receiv:0,client_request:0,clone:1,close:[0,3],closed_callback:3,closer:4,cluster:4,code:[0,4],com:[0,1],combin:4,come:4,command:[0,1],common:4,commun:[0,1,3,4,5],compat:[3,4],complet:[0,1,3,4,5],compon:4,compos:4,compress:[0,3,4],comput:[1,4],concaten:3,concept:4,conclud:[0,3],concurr:4,condit:4,config:[0,1],configarg:0,configdir:3,configpath:0,configur:[0,3,4,5],confirm:[4,5],connect:[0,3,4,5],consequ:4,consid:[4,5],consist:4,constant:[3,4],construct:4,contact:4,contain:[0,3,4],content:[],context:4,control:[0,3,4],conveni:0,convent:0,coordin:[3,4,5],core:[4,5],correct:[0,4],correctli:0,correspond:4,cost:[4,5],could:[0,3,4,5],count:4,counter:0,cover:5,cpu:0,creat:[0,1,3,4],create_kei:3,create_receipt:[0,3],creation:4,creator:4,critic:4,cryptograph:5,cryptographi:[1,4,5],ctrl:0,cull:3,current:[0,2,3,4],current_download:0,current_filenam:0,curv:[3,4,5],curve25519:[3,4,5],custom:[3,4],d:4,daemon:3,dai:4,data:[0,3,4,5],date:0,debian:4,debug:3,decai:4,decid:[3,4],decod:0,decrypt:[3,4],dedic:4,def:0,default_timeout:[],defin:[0,4],definit:4,delai:4,deliv:[0,3],deliveri:[0,3,5],demand:3,demonstr:0,depend:1,deploi:4,deregist:3,deregister_announce_handl:3,deregister_request_handl:3,deriv:[4,5],describ:[3,4],descript:0,design:[4,5],desir:[0,4],destin:[0,1,2],destination_1:0,destination_2:0,destination_clos:0,destination_hash:[0,3],destination_hexhash:0,detail:[0,2,3],detect:0,determin:[3,4],develop:[2,4,5],devic:[2,3,4],dh:3,did:0,differ:[0,1,3,4,5],diffi:[4,5],digit:[4,5],dir:0,direct:[0,3,4],directli:[3,4,5],directori:0,disable_encrypt:3,disappear:3,discard:4,disconnect:0,discoveri:4,discuss:4,disk:[0,3],displai:[0,4],distanc:4,distinct:4,distribut:[0,3,4],divmod:0,document:4,doe:[0,2,3,4],don:[0,1],done:[0,4],dot:4,down:0,downgrad:3,download:0,download_began:0,download_conclud:0,download_finish:0,download_start:0,download_tim:0,driver:5,drop:4,duplex:[4,5],e:0,each:[0,4],earlier:4,eas:4,easi:[4,5],easiest:[1,4],easili:[4,5],ecdh:[4,5],echo:[1,2],echo_destin:0,echo_request:0,ed25519:[4,5],effici:[0,4,5],ei:0,either:4,elif:0,ellipt:[3,4,5],els:[0,4],emploi:4,emptor:2,enabl:3,enable_transport:4,encapsul:5,encod:0,encrypt:[0,1,3,4,5],encrypted_mdu:3,encryptionless:3,end:[0,3,4,5],endpoint:[0,3,4],engin:4,ensur:4,enter:0,entir:4,entiti:4,entri:[0,4],enumer:0,environ:4,environment:4,environmentlogg:4,ephemer:[3,4,5],equal:4,equip:4,equl:[],error:[0,3],essenti:4,establish:[0,3,5],established_callback:3,establishment_timeout_per_hop:3,ethernet:[4,5],even:[4,5],everi:[0,3,4],everyon:4,everyth:[0,4],exact:4,exactli:[3,4],exampl:[1,2,3,4,5],example_util:0,exampleannouncehandl:0,exce:0,except:[0,4],exchang:[3,4,5],execut:[0,3],exhaust:4,exist:[0,4,5],exit:[0,1,3],exit_handl:0,expand:4,expect:[0,3,4],experi:[1,4],experiment:5,explain:3,explan:4,explicit:3,explicitli:3,explor:[0,4,5],expos:3,extend:[0,4],extern:[3,5],extrem:5,fa7ddfab5213f916dea:4,face:1,fact:[4,5],fail:[0,3],failed_callback:[0,3],fals:[0,3],far:4,fast:2,featur:[4,5],feed:3,feedback:0,fernet:5,few:[4,5],field:4,file:[0,1,3,4,5],file_resourc:0,file_s:0,filelist:0,filelist_data:0,filelist_receiv:0,filelist_timeout_job:0,filenam:0,filetransf:[1,2,3],filter:[0,4],find:4,firmwar:4,first:[0,3,4],fit:0,five:0,fix:4,flag:[3,4],flush:0,folder:1,follow:[0,4,5],forcibl:3,foremost:5,form:[3,4],format:[0,2,5],forth:0,forward:[3,4,5],found:[0,1,4],free:5,frequenc:4,friendli:5,from:[0,1,3,4,5],from_byt:3,from_fil:3,fromhex:0,fruit:0,full:[0,3,4],full_hash:3,full_nam:3,fulli:[4,5],funcion:3,fundament:4,further:[1,2],futur:[3,4],g:0,ga:0,gatekeep:4,gener:[0,3,4,5],generalis:5,get:[0,2,3,5],get_private_kei:3,get_progress:[0,3],get_public_kei:3,get_random_hash:[0,3],get_remote_ident:[0,3],get_request_id:3,get_respons:3,get_response_tim:3,get_rtt:[0,3],get_statu:3,gi:0,gigabyt:5,git:1,github:[0,1],give:4,given:4,global:[0,5],go:[0,1,4],goal:2,good:4,got:0,got_respons:0,govern:4,grape:0,great:4,greater:4,group:[3,4],guarante:4,guid:[1,3,4],h:[1,4],ha:[0,3,4,5],had:4,half:[4,5],hand:0,handheld:4,handl:[0,3,4,5],handler:[0,3],happen:[0,3],hardwar:[3,4,5],has_path:[0,3],hasattr:0,hash:[0,1,3,4],hash_from_name_and_ident:3,hashmap:0,have:[0,1,3,4],hazard:3,header:4,header_1:4,header_2:4,header_typ:[],hear:4,heard:[3,4],helium:0,hellman:[4,5],help:[0,4,5],here:[0,4],hexadecim:[0,4],high:[4,5],higher:[4,5],highli:4,hint:0,hit:0,hmac:5,hoc:5,hold:[3,4],hop:[3,4,5],hops_to:3,host:[0,4,5],hour:0,how:[0,4,5],howev:4,http:[0,1],human:[0,3],i:0,id:[3,4],idea:4,ident:[0,2],identif:[2,5],identifi:[0,3,4],identify:4,identifyexampl:0,ie:[],ignor:[3,4],immedi:1,impact:4,implement:[0,3,4,5],implicit:[3,4],inactive_for:3,inbound:3,includ:[0,3,4],incom:[0,3],incompat:[3,4],indefinit:4,independ:3,independt:5,index:[0,2],indirectli:4,individu:4,inevit:4,infer:4,info:[3,4],inform:[0,1,2,3,4],infrastructur:4,ingo:3,initi:[0,3,4],initialis:[0,3],input:0,insert:4,instal:1,instanc:[0,3],instanti:3,instead:[0,4],integr:4,intend:4,intention:4,inter:3,interact:[0,3,4],interest:4,interfac:[0,2,3,4],intern:[3,4],internet:[4,5],interv:3,intiat:0,introduc:4,introduct:2,intuit:5,invalid:[0,3],investig:4,ip:[4,5],is_request:[],is_respons:[],isdir:0,isfil:0,ism:4,its:[3,4],itself:[2,3,4],iv:5,job:0,join:[0,4],just:[0,4,5],k:0,kbp:4,keep:[0,3,4,5],keepal:[3,4],kei:[0,2,3,5],kept:[3,4],kernel:5,keyboardinterrupt:0,keyerror:3,keypair:4,keysiz:3,ki:0,kill:3,kilomet:4,kind:4,know:[0,3,4],knowledg:4,known:[0,3,4],krypton:0,lack:4,laid:4,larg:[0,4],larger:4,last:[0,3],last_unit:0,latenc:[4,5],later:0,latest:[0,1],latest_client_link:0,launch:1,lavg:4,layer:[4,5],lead:4,learn:[0,4],least:[4,5],leav:4,ledger:4,left:[3,4],len:0,length:[0,3],less:[4,5],let:[0,4],level:4,librari:1,licens:4,light:4,like:[1,3,4],limit:4,line:[0,1,4,5],link:[2,5],link_clos:0,link_establish:0,linkexampl:0,linux:4,list:[0,3,4],list_deliv:0,list_fil:0,list_packet:0,list_receipt:0,list_timeout:0,listdir:0,listen:[0,4],littl:4,lki:4,lkr:4,ll:[0,1,5],ln:1,load:[0,3],load_private_kei:3,load_public_kei:3,local:[0,3,4,5],locat:4,log:0,log_error:0,log_info:0,loglevel:0,longer:[0,4],look:[0,1,4],loop:0,lora:[4,5],lorawan:4,lot:4,low:[4,5],lxmf:1,m:[0,4],mac:4,machin:4,made:[3,4],mai:4,main:0,maintain:4,make:[1,4],malici:4,manag:3,mani:[0,4,5],manipul:4,manual:[0,1,3],mark:4,markqvist:[0,1],master:[0,3],match:0,maximum:[3,4],mcu:4,mdu:0,mean:4,measur:4,mechan:2,medium:[4,5],memori:4,mention:4,menu:0,menu_mod:0,mesh:5,messag:[0,1,3,4],messeng:4,metavar:0,method:[0,3,4],methodolog:4,mhz:4,mi:0,microcontrol:4,microwav:4,might:4,millisecond:0,mind:5,minim:[2,4],minimalsampl:0,minimum:[0,4],minut:[0,4],mode:[0,1,4,5],modem:[3,4,5],modul:[0,4,5],moment:[4,5],monitor:4,moon:0,more:[3,4,5],most:[1,4,5],motiv:2,move:1,mtu:[3,4,5],much:4,multi:[4,5],multilater:4,multipl:[0,4],multipoint:4,must:[0,3,4],my:4,n:0,name:[0,3],namespac:0,nano:1,narg:0,necessari:[1,3,4],necessarili:4,need:[0,2,4,5],neglig:4,neither:4,neon:0,network:[0,1,3,4,5],never:3,newer:4,newest:4,newli:4,next:[1,4],nicknam:4,no_inbound_for:3,no_outbound_for:3,nobl:0,noble_ga:0,noble_gas:0,node:[2,5],nomad:1,non:[3,4],none:[0,3,4],normal:0,notat:4,note:[0,4],noth:5,notic:4,notif:[0,3],now:[0,1,4],nt:0,num:0,number:[0,3,4],object:3,obtain:4,occur:5,off:[4,5],offer:[2,3,4],often:4,oganesson:0,old:4,onc:[0,3,4,5],one:[0,3,4,5],onli:[0,3,4,5],onlin:4,open:[0,3,4,5],openmodem:5,oper:[3,4,5],opt:4,optic:5,option:[0,1,3],orient:4,origin:[0,4],original_hash:[],os:[0,4,5],ospf:4,other:[3,4],otherwis:[3,4],our:[0,4],out:[0,3,4,5],outbound:3,outgo:[0,3,4],outlin:[1,4],outward:4,over:[0,3,4,5],overal:4,overcom:4,overhead:4,overrid:0,overview:4,own:[0,1,3,4],owner:[],p:[0,4],pack:0,packb:0,packet:[0,2,5],packet_callback:0,packet_deliv:0,packet_receipt:[0,3],packet_timed_out:0,packet_typ:[],packetreceipt:[0,3],pad:5,page:[2,4],pair:4,palm:0,paramet:3,pars:0,parse_arg:0,parser:0,part:[0,4],particip:[2,4],pass:[0,3,4],path:[0,1,3,4],path_respons:3,pathfind:[],pathfinder_m:3,pattern:4,payload:[3,4],peach:0,peer:[0,3,4],peer_pub_byt:[],peer_sig_pub_byt:[],peopl:4,per:[3,4,5],percent:0,perfect:4,perform:[0,4],period:4,persecut:4,person:4,pet:0,philosophi:4,physic:4,pi:[0,4,5],piec:4,ping:1,pip3:1,pip:1,pkcs7:5,place:4,plain:[0,3,4],plain_mdu:3,plaintext:[0,3],platform:4,pleas:[0,5],plenti:4,plu:4,pmr:4,point:4,pomelo:0,port:[4,5],possess:4,possibl:[3,4,5],potenti:[0,4],practic:[4,5],pre:[3,4],predict:4,prefer:4,prepar:0,prerequisit:3,presenc:3,preserv:3,press:0,pretend:4,pretti:4,prettyhexrep:0,previou:0,previous:[3,4],primari:4,principl:[4,5],print:0,print_filelist:0,print_help:0,print_menu:0,prioriti:4,prioritis:2,privaci:5,privat:[3,4,5],probabl:[0,4,5],procedur:4,process:[1,3,4],product:3,program:[0,2,3,4],program_setup:0,programm:4,programmat:4,progress:[0,3,5],progress_callback:3,project:1,prompt:0,proof:[0,3,4],proof_requested_callback:3,proof_strategi:3,propag:4,properti:3,protocol:[1,2,5],prove:[0,4],prove_al:[0,3],prove_app:3,prove_non:3,proven:[3,4],provid:[0,1,2,3,4,5],prv_byte:3,pub_byt:3,public_inform:0,purchas:[4,5],purg:3,purpos:[3,4],purposefulli:4,put:0,py:[0,1],pyseri:1,python3:1,python:[4,5],q:0,queri:0,queue:4,quinc:0,quit:0,r:[0,4],radio:[3,4,5],radiu:4,radon:0,rais:[0,3],rand:4,randint:0,random:[0,3,4],random_text_gener:0,randomli:[0,4],rang:[0,4,5],raspberri:[4,5],rate:0,rb:0,re:[0,3,4],reach:2,reachabl:[0,3,4],read:[0,1,4],readabl:[0,3,4],readi:[0,1,3],readili:5,real:5,realli:3,reason:4,reassembl:4,recal:[0,3],recall_app_data:3,recap:4,receipt:[0,2,4],receiv:[0,3,4],received_announc:[0,3],recip:1,recipi:4,recommend:[0,4],reconstruct:4,record:4,recreat:4,refer:[0,1,2],regard:4,regist:[0,3],register_announce_handl:[0,3],register_request_handl:[0,3],rel:[4,5],releas:[1,4],relev:[0,3],reli:4,reliabl:[4,5],rem:0,remain:4,rememb:4,remot:[0,3,5],remote_ident:[0,3],remote_identifi:0,remote_identity_hash:[],remote_p:0,remotesensor:4,repeat:1,replac:[1,4],repli:0,replic:4,reply_data:0,reply_text:0,repositori:1,repres:4,represent:[0,4],request:[2,4],request_destin:0,request_fail:0,request_id:[0,3],request_packet:0,request_path:[0,3],request_receipt:[0,3],request_receiv:0,requested_at:[0,3],requestexampl:0,requestreceipt:3,requir:[0,4,5],research:5,resend:3,reserv:4,resili:5,resourc:[0,2],resource_callback:3,resource_sending_conclud:0,resource_strategi:3,respond:[0,3],respons:[2,3],response_callback:[0,3],response_gener:[0,3],response_tim:[],rest:5,result:[0,4],reticulum:0,retransmiss:4,retransmit:4,retri:4,reveal:[3,4],review:5,right:[],rn:[0,1,3],rnode:[4,5],robot:4,rotat:4,round:[0,3],rout:[3,4,5],rprogress:0,rsa:[],rtt:[0,3,4],rttstring:0,rule:4,run:[0,1,3,4,5],runtim:4,rw:4,s:[0,1,4,5],said:4,same:[1,3,4],satisfi:4,save:[3,4],save_error:0,saved_filenam:0,scenario:[1,4],screen:0,search:2,second:[0,3,4,5],secreci:[3,4,5],section:4,secur:[4,5],see:[0,3,4],seen:4,segment_index:[],select:0,self:[0,5],send:[0,3,4],sender:[0,4],sendig:0,sensibl:1,sensor:4,sent:[0,3,4],sentiment:4,separ:4,sequenc:[0,3,4,5],serial:[4,5],serv:[0,4],serve_path:0,server:[0,1],server_callback:0,server_destin:0,server_fil:0,server_ident:0,server_link:0,server_loop:0,server_packet_receiv:0,session:4,set:[0,3,4,5],set_default_app_data:3,set_delivery_callback:[0,3],set_link_closed_callback:0,set_link_established_callback:[0,3],set_packet_callback:[0,3],set_proof_requested_callback:3,set_proof_strategi:[0,3],set_remote_identified_callback:[0,3],set_resource_callback:3,set_resource_concluded_callback:[0,3],set_resource_started_callback:[0,3],set_resource_strategi:[0,3],set_timeout:[0,3],set_timeout_callback:[0,3],setdaemon:0,setup:[0,2],sever:3,sha256:5,sha:[3,4],shall:4,share:[1,3,4],shelf:[4,5],shop:0,shortest:4,should:[0,3,4,5],should_allow_unencrypt:3,should_quit:0,should_use_implicit_proof:3,shown:0,side:5,sign:[3,4],signatur:[3,4,5],significantli:[],similar:5,simpl:[0,4,5],simplest:4,simpli:[0,1,4],simplic:4,sinc:[0,3,4],singl:[0,3,4],singular:4,situat:4,size:[0,3,4],size_str:0,sleep:0,slice:0,slow:[0,4],small:[0,4],so:[0,1,3,4,5],softwar:[4,5],some:[0,1,4],someth:4,somethign:0,soon:3,sort:4,sourc:[0,1,4,5],space:[0,5],span:4,special:4,specif:[0,2,3,5],specifi:[0,3],spectrum:4,split:0,sponsor:5,stabl:[4,5],stack:[0,1,4,5],stage:4,stai:0,standard:4,start:[0,2,3,4],startup:0,state:0,station:4,statist:0,statu:[0,2,3,4],stdout:0,step:1,still:[0,4],stock:0,stop:5,store:[0,4],store_tru:0,str:0,strategi:3,stream:4,strength:5,strictli:4,string:[0,3],structur:4,subject:4,subsequ:4,successful:3,successfulli:0,sucessfulli:4,suffic:4,suffici:4,suffix:0,suit:[1,4],suitabl:[0,4],suppli:[3,4],support:[0,2,4],sy:0,symlink:1,symmetr:[3,4],system:[0,2,3,5],t:[0,1,4],tabl:4,take:[0,1,4,5],taken:[0,4],tangerin:0,target:0,tcp:[4,5],tdata:0,teardown:[0,3],teardown_reason:0,teffect:0,tell:0,temperatur:4,ten:4,term:4,termin:3,terminolog:4,test:4,text:[0,4],tfile:0,than:[0,4],thei:[0,3,4],them:[0,4],thereaft:4,therefor:[4,5],thi:[0,1,2,3,4],though:4,thourough:5,thread:0,three:4,through:[3,4,5],throughout:4,throughput:[4,5],thu:[3,4],ti:[0,4],time:[0,1,3,4],timeout:[0,3],timeout_callback:[],timeoutarg:0,timestr:0,tnc:[3,5],to_fil:3,todai:4,todo:[],togeth:4,token:[3,4],too:[0,4],tool:5,top:4,topic:4,topolog:4,total:[4,5],total_s:0,touch:5,toward:[0,4],traffic:[0,3,4],tramsit:[],transceiv:[4,5],transfer:[0,3,4,5],transfer_s:0,transmiss:4,transmit:[0,4],transpar:4,transport:[0,2,5],transport_en:3,transport_id:[],transport_typ:[],travers:4,treat:4,tri:0,trip:[0,3],trivial:5,truli:4,truncat:[3,4],truncated_hash:3,truncated_hashlength:3,trust:4,trustless:[4,5],ttime:0,ttransfer:0,tunnel:[4,5],tupl:3,two:[0,4],type:[0,2,3],typeerror:3,udp:[4,5],umsgpack:0,uncencrypt:0,underli:5,understand:[1,2],unencrypt:[0,3,4],unequivoc:4,unforg:5,unidentifi:0,uninterest:0,uniqu:[4,5],unit:0,unknown:[0,3,4],unless:[1,3,4],unlicens:4,unpack:0,unpackb:0,unsupport:3,until:[0,3,4],unwant:4,up:[0,4,5],updat:[0,3],upon:[0,4],upset:0,urandom:5,us:[0,2,3,4],usabl:4,usag:[],usb:[4,5],useabl:4,user:[0,1,3,4],user_input:0,userland:5,utf:0,util:[0,1,4],utilis:[4,5],valid:[0,3,4],valu:[3,4],valueerror:[0,3],variabl:0,varieti:[4,5],variou:[0,4],ve:1,vendor:0,veri:[3,4,5],verif:[3,4],verifi:[0,3,4],versa:5,version:3,vhf:4,via:[1,4],vice:5,view:4,visibl:0,wa:[0,3,4,5],wai:[0,1,4],wait:[0,4],want:[0,1,4,5],warrant:5,wb:0,we:[0,4],well:[3,4,5],went:0,what:[0,1,2,3,4],whatev:[3,4],when:[0,1,3,4],whenev:3,where:[2,3,4],whereupon:4,whether:[0,3,4],which:[0,1,3,4],who:4,wide:[4,5],wifi:[4,5],wildcard:0,window:4,wire:[4,5],wish:4,within:[0,3,4],won:0,work:[4,5],world:5,would:4,write:[0,3],written:4,wrong:0,x25519:[3,4,5],x:4,xenon:0,y:0,ye:4,year:4,yet:[0,4],yi:0,you:[0,1,2,3,4,5],your:[0,1,4,5],yourself:[4,5],z:0,zero:3,zi:0},titles:["Examples","Getting Started Fast","Reticulum Network Stack Manual","API Reference","Understanding Reticulum","What is Reticulum?"],titleterms:{"1":[],"2":[],"class":3,"function":4,"public":4,"try":1,The:4,announc:[0,4],api:3,base:1,basic:4,binari:4,broadcast:0,can:5,caveat:5,current:5,deliveri:[],destin:[3,4],detail:4,develop:1,devic:5,doe:5,echo:0,emptor:5,establish:4,exampl:0,fast:1,filetransf:0,format:4,further:4,get:[1,4],goal:4,ident:[3,4],identif:0,indic:2,interfac:5,introduct:4,kei:4,link:[0,3,4],manual:2,mechan:4,minim:0,motiv:4,name:4,network:2,node:4,offer:5,packet:[3,4],particip:1,pathfind:[],prioritis:4,program:1,protocol:4,proven:[],reach:4,receipt:3,refer:[3,4],request:[0,3],resourc:[3,4],respons:0,reticulum:[1,2,3,4,5],setup:4,specif:4,stack:2,start:1,statu:5,step:[],support:5,system:4,tabl:2,transport:[3,4],type:[4,5],understand:4,us:[1,5],what:5,where:5}}) \ No newline at end of file diff --git a/docs/manual/understanding.html b/docs/manual/understanding.html index a535d6e..c9e2b69 100644 --- a/docs/manual/understanding.html +++ b/docs/manual/understanding.html @@ -5,7 +5,7 @@ - Understanding Reticulum — Reticulum Network Stack 0.2.3 beta documentation + Understanding Reticulum — Reticulum Network Stack 0.2.4 beta documentation @@ -31,7 +31,7 @@
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Understanding Reticulum
    • @@ -490,7 +490,7 @@ At the same time we establish an efficient encrypted channel. The setup of this terms of bandwidth, so it can be used just for a short exchange, and then recreated as needed, which will 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.

    -

    The combined bandwidth cost of setting up a link is 3 packets totalling 240 bytes (more info in the +

    The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the Binary Packet Format 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 radio channel, 100 concurrent links will still leave 95% channel capacity for actual data.

    @@ -764,7 +764,7 @@ proof 11 - Announce : 151 bytes - Link Request : 77 bytes - Link Proof : 77 bytes - - Link RTT packet : 86 bytes + - Link RTT packet : 83 bytes - Link keepalive : 14 bytes @@ -853,7 +853,7 @@ proof 11
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • Understanding Reticulum
    • diff --git a/docs/manual/whatis.html b/docs/manual/whatis.html index 47ee4e0..a6ca359 100644 --- a/docs/manual/whatis.html +++ b/docs/manual/whatis.html @@ -5,7 +5,7 @@ - What is Reticulum? — Reticulum Network Stack 0.2.3 beta documentation + What is Reticulum? — Reticulum Network Stack 0.2.4 beta documentation @@ -31,7 +31,7 @@
  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • What is Reticulum?
    • @@ -82,7 +82,7 @@

  • Efficient link establishment

      -

    • Total bandwidth cost of setting up a link is only 3 packets, totalling 240 bytes

      • +

    • Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes

    • Low cost of keeping links open at only 0.62 bits per second

    • @@ -182,7 +182,7 @@ network, and vice versa.

  • previous |
    • -
  • Reticulum Network Stack 0.2.3 beta documentation »
    • +
  • Reticulum Network Stack 0.2.4 beta documentation »
  • What is Reticulum?
    • diff --git a/docs/source/conf.py b/docs/source/conf.py index 3022498..009edeb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ copyright = '2021, Mark Qvist' author = 'Mark Qvist' # The full version, including alpha/beta/rc tags -release = '0.2.3 beta' +release = '0.2.4 beta' # -- General configuration --------------------------------------------------- diff --git a/docs/source/reference.rst b/docs/source/reference.rst index b5d3cf0..e09ec49 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -39,7 +39,7 @@ Destination Packet ------ -.. autoclass:: RNS.Packet +.. autoclass:: RNS.Packet(destination, data, create_receipt = True) :members: .. _api-packetreceipt: @@ -47,7 +47,7 @@ Packet Packet Receipt -------------- -.. autoclass:: RNS.PacketReceipt +.. autoclass:: RNS.PacketReceipt() :members: .. _api-link: @@ -55,7 +55,15 @@ Packet Receipt Link ---- -.. autoclass:: RNS.Link +.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None) + :members: + +.. _api-requestreceipt: + +Request Receipt +--------------- + +.. autoclass:: RNS.RequestReceipt() :members: .. _api-resource: @@ -63,7 +71,7 @@ Link Resource -------- -.. autoclass:: RNS.Resource +.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None) :members: .. _api-transport: diff --git a/docs/source/understanding.rst b/docs/source/understanding.rst index 8acb773..3766191 100644 --- a/docs/source/understanding.rst +++ b/docs/source/understanding.rst @@ -429,7 +429,7 @@ 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 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 240 bytes (more info in the +The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the :ref:`Binary Packet Format` 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 radio channel, 100 concurrent links will still leave 95% channel capacity for actual data. @@ -701,5 +701,5 @@ Binary Packet Format - Announce : 151 bytes - Link Request : 77 bytes - Link Proof : 77 bytes - - Link RTT packet : 86 bytes + - Link RTT packet : 83 bytes - Link keepalive : 14 bytes \ No newline at end of file diff --git a/docs/source/whatis.rst b/docs/source/whatis.rst index 2505423..1a6dcaa 100644 --- a/docs/source/whatis.rst +++ b/docs/source/whatis.rst @@ -57,7 +57,7 @@ What does Reticulum Offer? * Efficient link establishment - * Total bandwidth cost of setting up a link is only 3 packets, totalling 240 bytes + * Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes * Low cost of keeping links open at only 0.62 bits per second