Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-13 20:18:10 -07:00
Code Issues Packages Projects Releases Wiki Activity

Added markdown manual build

Browse Source
This commit is contained in:
Mark Qvist
2026-05-06 21:18:01 +02:00
parent 4d6e164d62
commit ec27d8bfde
18 changed files with 1025 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/reference.md
+1 -31
View File
@@ -1,12 +1,8 @@
<a id="api-main"></a>
# API Reference
Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.
This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
<a id="api-reticulum"></a>
### *class* RNS.Reticulum(configdir=None, loglevel=None, logdest=None, verbosity=None, require_shared_instance=False, shared_instance_type=None)
This class is used to initialise access to Reticulum within a
@@ -162,8 +158,6 @@ interfaces are discovered.
* **Returns:**
A list of identity hashes.
<a id="api-identity"></a>
### *class* RNS.Identity(create_keys=True)
This class is used to manage identities in Reticulum. It provides methods
@@ -360,8 +354,6 @@ Validates the signature of a signed message.
* **Raises:**
*KeyError* if the instance does not hold a public key.
<a id="api-destination"></a>
### *class* RNS.Destination(identity, direction, type, app_name, \*aspects)
A class used to describe endpoints in a Reticulum Network. Destination
@@ -584,8 +576,6 @@ unless other app_data is specified in the *announce* method.
Clears default app_data previously set for the destination.
<a id="api-packet"></a>
### *class* RNS.Packet(destination, data, create_receipt=True)
The Packet class is used to create packet instances that can be sent
@@ -645,8 +635,6 @@ Re-sends the packet.
* **Returns:**
The physical layer *Link Quality* if available, otherwise `None`.
<a id="api-packetreceipt"></a>
### *class* RNS.PacketReceipt
The PacketReceipt class is used to receive notifications about
@@ -685,8 +673,6 @@ Sets a function that gets called if the delivery times out.
* **Parameters:**
**callback** – A *callable* with the signature *callback(packet_receipt)*
<a id="api-link"></a>
### *class* RNS.Link(destination, established_callback=None, closed_callback=None)
This class is used to establish and manage links to other peers. When a
@@ -900,8 +886,6 @@ Sets the resource strategy for the link.
* **Raises:**
*TypeError* if the resource strategy is unsupported.
<a id="api-requestreceipt"></a>
### *class* RNS.RequestReceipt
An instance of this class is returned by the `request` method of `RNS.Link`
@@ -938,8 +922,6 @@ check status, response time and response data when the request concludes.
* **Returns:**
True if the associated request has concluded (successfully or with a failure), otherwise False.
<a id="api-resource"></a>
### *class* RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)
The Resource class allows transferring arbitrary amounts
@@ -998,8 +980,6 @@ Cancels transferring the resource.
* **Returns:**
Whether the resource is compressed.
<a id="api-channel"></a>
### *class* RNS.Channel.Channel
Provides reliable delivery of messages over
@@ -1084,8 +1064,6 @@ message header information.
* **Returns:**
number of bytes available
<a id="api-messsagebase"></a>
### *class* RNS.MessageBase
Base type for any messages sent or received on a Channel.
@@ -1113,8 +1091,6 @@ Populate message from binary representation
* **Parameters:**
**raw** – binary representation
<a id="api-buffer"></a>
### *class* RNS.Buffer
Static functions for creating buffered streams that send
@@ -1178,8 +1154,6 @@ of this object, see the Python documentation for
* **Returns:**
a BufferedRWPair object
<a id="api-rawchannelreader"></a>
### *class* RNS.RawChannelReader(stream_id: int, channel: [Channel](#RNS.Channel.Channel))
An implementation of RawIOBase that receives
@@ -1218,8 +1192,6 @@ Remove a function added with [`RNS.RawChannelReader.add_ready_callback()`](#RNS.
* **Parameters:**
**cb** – function to remove
<a id="api-rawchannelwriter"></a>
### *class* RNS.RawChannelWriter(stream_id: int, channel: [Channel](#RNS.Channel.Channel))
An implementation of RawIOBase that receives
@@ -1243,8 +1215,6 @@ Create a raw channel writer.
* **stream_id** – remote stream id to sent do
* **channel** – `Channel` object to send on
<a id="api-transport"></a>
### *class* RNS.Transport
Through static methods of this class you can interact with the
@@ -1320,4 +1290,4 @@ will announce it.
* **Parameters:**
* **destination_hash** – A destination hash as *bytes*.
* **on_interface** – 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.
* **on_interface** – 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.