Reticulum/docs/source/reference.rst

147 lines
2.2 KiB
ReStructuredText
Raw Normal View History

2022-09-30 11:09:10 +00:00
:tocdepth: 4
2021-05-16 19:58:11 +00:00
.. _api-main:
2021-05-16 15:36:50 +00:00
*************
API Reference
*************
2022-09-30 11:09:10 +00:00
This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their methods and usage. It can be used as a reference while writing applications that utilise Reticulum, or read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
2021-05-16 15:36:50 +00:00
2021-05-16 21:13:56 +00:00
Classes
2021-05-16 19:58:11 +00:00
=========================
2022-09-30 11:09:10 +00:00
Communication over a Reticulum network is achieved using a set of classes exposed by the RNS API.
2021-05-16 19:58:11 +00:00
.. _api-reticulum:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Reticulum |end-h3|
.. only:: latex
Reticulum
---------
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Reticulum
:members:
.. _api-identity:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Identity |end-h3|
.. only:: latex
Identity
--------
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Destination |end-h3|
.. only:: latex
Destination
-----------
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Packet |end-h3|
.. only:: latex
Packet
------
2021-05-16 15:36:50 +00:00
2021-09-02 18:35:42 +00:00
.. autoclass:: RNS.Packet(destination, data, create_receipt = True)
2021-05-16 19:58:11 +00:00
:members:
2021-05-16 21:13:56 +00:00
.. _api-packetreceipt:
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Packet Receipt |end-h3|
.. only:: latex
Packet Receipt
--------------
2021-05-16 21:13:56 +00:00
2021-09-02 18:35:42 +00:00
.. autoclass:: RNS.PacketReceipt()
2021-05-16 21:13:56 +00:00
:members:
2021-05-16 19:58:11 +00:00
.. _api-link:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Link |end-h3|
.. only:: latex
Link
----
2021-05-16 15:36:50 +00:00
2021-09-02 18:35:42 +00:00
.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None)
:members:
.. _api-requestreceipt:
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Request Receipt |end-h3|
.. only:: latex
Request Receipt
---------------
2021-09-02 18:35:42 +00:00
.. autoclass:: RNS.RequestReceipt()
2021-05-16 19:58:11 +00:00
:members:
.. _api-resource:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Resource |end-h3|
.. only:: latex
Resource
--------
2021-05-16 15:36:50 +00:00
2021-09-02 18:35:42 +00:00
.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)
2021-05-16 19:58:11 +00:00
:members:
.. _api-transport:
2021-05-16 15:36:50 +00:00
2022-09-30 11:09:10 +00:00
.. only:: html
|start-h3| Transport |end-h3|
.. only:: latex
Transport
---------
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Transport
2022-09-30 11:09:10 +00:00
:members:
.. |start-h3| raw:: html
<h3>
.. |end-h3| raw:: html
</h3>