Reticulum/docs/source/reference.rst

83 lines
1.2 KiB
ReStructuredText
Raw Normal View History

2021-05-16 21:58:11 +02:00
.. _api-main:
2021-05-16 17:36:50 +02:00
*************
API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
2021-05-16 23:13:56 +02:00
Classes
2021-05-16 21:58:11 +02:00
=========================
2021-05-16 23:39:26 +02:00
Communication over a Reticulum network is achieved using a set of classes exposed by RNS.
2021-05-16 21:58:11 +02:00
.. _api-reticulum:
2021-05-16 17:36:50 +02:00
Reticulum
---------
2021-05-16 21:58:11 +02:00
.. autoclass:: RNS.Reticulum
:members:
.. _api-identity:
2021-05-16 17:36:50 +02:00
Identity
--------
2021-05-16 21:58:11 +02:00
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
2021-05-16 17:36:50 +02:00
Destination
-----------
2021-05-16 21:58:11 +02:00
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
2021-05-16 17:36:50 +02:00
Packet
------
2021-09-02 20:35:42 +02:00
.. autoclass:: RNS.Packet(destination, data, create_receipt = True)
2021-05-16 21:58:11 +02:00
:members:
2021-05-16 23:13:56 +02:00
.. _api-packetreceipt:
Packet Receipt
--------------
2021-09-02 20:35:42 +02:00
.. autoclass:: RNS.PacketReceipt()
2021-05-16 23:13:56 +02:00
:members:
2021-05-16 21:58:11 +02:00
.. _api-link:
2021-05-16 17:36:50 +02:00
Link
----
2021-09-02 20:35:42 +02:00
.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None)
:members:
.. _api-requestreceipt:
Request Receipt
---------------
.. autoclass:: RNS.RequestReceipt()
2021-05-16 21:58:11 +02:00
:members:
.. _api-resource:
2021-05-16 17:36:50 +02:00
Resource
--------
2021-09-02 20:35:42 +02:00
.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)
2021-05-16 21:58:11 +02:00
:members:
.. _api-transport:
2021-05-16 17:36:50 +02:00
Transport
---------
2021-05-16 21:58:11 +02:00
.. autoclass:: RNS.Transport
:members: