Reticulum/docs/source/reference.rst
2021-05-16 21:58:11 +02:00

68 lines
845 B
ReStructuredText

.. _api-main:
*************
API Reference
*************
This reference guide lists and explains all classes exposed by the RNS API.
Primary Interface Classes
=========================
Communication over a Reticulum network in a program is acheived using a set of
classes exposed by RNS.
.. _api-reticulum:
Reticulum
---------
.. autoclass:: RNS.Reticulum
:members:
.. _api-identity:
Identity
--------
.. autoclass:: RNS.Identity
:members:
.. _api-destination:
Destination
-----------
.. autoclass:: RNS.Destination
:members:
.. _api-packet:
Packet
------
.. autoclass:: RNS.Packet
:members:
.. _api-link:
Link
----
.. autoclass:: RNS.Link
:members:
.. _api-resource:
Resource
--------
.. autoclass:: RNS.Resource
:members:
.. _api-transport:
Transport
---------
.. autoclass:: RNS.Transport
:members: