Reticulum/docs/source/reference.rst

75 lines
916 B
ReStructuredText
Raw Normal View History

2021-05-16 19:58:11 +00:00
.. _api-main:
2021-05-16 15:36:50 +00:00
*************
API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
2021-05-16 21:13:56 +00:00
Classes
2021-05-16 19:58:11 +00:00
=========================
2021-05-16 21:39:26 +00:00
Communication over a Reticulum network is achieved using a set of classes exposed by RNS.
2021-05-16 19:58:11 +00:00
.. _api-reticulum:
2021-05-16 15:36:50 +00:00
Reticulum
---------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Reticulum
:members:
.. _api-identity:
2021-05-16 15:36:50 +00:00
Identity
--------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
2021-05-16 15:36:50 +00:00
Destination
-----------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
2021-05-16 15:36:50 +00:00
Packet
------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Packet
:members:
2021-05-16 21:13:56 +00:00
.. _api-packetreceipt:
Packet Receipt
--------------
.. autoclass:: RNS.PacketReceipt
:members:
2021-05-16 19:58:11 +00:00
.. _api-link:
2021-05-16 15:36:50 +00:00
Link
----
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Link
:members:
.. _api-resource:
2021-05-16 15:36:50 +00:00
Resource
--------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Resource
:members:
.. _api-transport:
2021-05-16 15:36:50 +00:00
Transport
---------
2021-05-16 19:58:11 +00:00
.. autoclass:: RNS.Transport
:members: