mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-22 21:50:18 +00:00
428 lines
17 KiB
HTML
428 lines
17 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Index — Reticulum Network Stack 0.2.6 beta documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
|
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
|
|
<link rel="index" title="Index" href="#" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="#" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.6 beta documentation</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
|
|
<h1 id="index">Index</h1>
|
|
|
|
<div class="genindex-jumpbox">
|
|
<a href="#A"><strong>A</strong></a>
|
|
| <a href="#C"><strong>C</strong></a>
|
|
| <a href="#D"><strong>D</strong></a>
|
|
| <a href="#E"><strong>E</strong></a>
|
|
| <a href="#F"><strong>F</strong></a>
|
|
| <a href="#G"><strong>G</strong></a>
|
|
| <a href="#H"><strong>H</strong></a>
|
|
| <a href="#I"><strong>I</strong></a>
|
|
| <a href="#K"><strong>K</strong></a>
|
|
| <a href="#L"><strong>L</strong></a>
|
|
| <a href="#M"><strong>M</strong></a>
|
|
| <a href="#N"><strong>N</strong></a>
|
|
| <a href="#P"><strong>P</strong></a>
|
|
| <a href="#R"><strong>R</strong></a>
|
|
| <a href="#S"><strong>S</strong></a>
|
|
| <a href="#T"><strong>T</strong></a>
|
|
| <a href="#V"><strong>V</strong></a>
|
|
|
|
</div>
|
|
<h2 id="A">A</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Resource.advertise">advertise() (RNS.Resource method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.announce">announce() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.app_and_aspects_from_name">app_and_aspects_from_name() (RNS.Destination static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="C">C</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Resource.cancel">cancel() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.clear_default_app_data">clear_default_app_data() (RNS.Destination method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.create_keys">create_keys() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.CURVE">CURVE (RNS.Identity attribute)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Link.CURVE">(RNS.Link attribute)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="D">D</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.decrypt">decrypt() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Identity.decrypt">(RNS.Identity method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport.deregister_announce_handler">deregister_announce_handler() (RNS.Transport static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.deregister_request_handler">deregister_request_handler() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination">Destination (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="E">E</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.encrypt">encrypt() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Identity.encrypt">(RNS.Identity method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Packet.ENCRYPTED_MDU">ENCRYPTED_MDU (RNS.Packet attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.ESTABLISHMENT_TIMEOUT_PER_HOP">ESTABLISHMENT_TIMEOUT_PER_HOP (RNS.Link attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="F">F</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.from_bytes">from_bytes() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.from_file">from_file() (RNS.Identity static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.full_hash">full_hash() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.full_name">full_name() (RNS.Destination static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="G">G</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.get_private_key">get_private_key() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Identity.get_private_key">(RNS.Identity method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="reference.html#RNS.RequestReceipt.get_progress">get_progress() (RNS.RequestReceipt method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Resource.get_progress">(RNS.Resource method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="reference.html#RNS.Identity.get_public_key">get_public_key() (RNS.Identity method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.get_random_hash">get_random_hash() (RNS.Identity static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.get_remote_identity">get_remote_identity() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RequestReceipt.get_request_id">get_request_id() (RNS.RequestReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RequestReceipt.get_response">get_response() (RNS.RequestReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RequestReceipt.get_response_time">get_response_time() (RNS.RequestReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.get_rtt">get_rtt() (RNS.PacketReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.get_status">get_status() (RNS.PacketReceipt method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.RequestReceipt.get_status">(RNS.RequestReceipt method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="H">H</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport.has_path">has_path() (RNS.Transport static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.hash">hash() (RNS.Destination static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.hash_from_name_and_identity">hash_from_name_and_identity() (RNS.Destination static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Transport.hops_to">hops_to() (RNS.Transport static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="I">I</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.identify">identify() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity">Identity (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.inactive_for">inactive_for() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="K">K</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.KEEPALIVE">KEEPALIVE (RNS.Link attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.KEYSIZE">KEYSIZE (RNS.Identity attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="L">L</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link">Link (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.load_private_key">load_private_key() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Identity.load_private_key">(RNS.Identity method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.load_public_key">load_public_key() (RNS.Identity method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="M">M</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Reticulum.MTU">MTU (RNS.Reticulum attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="N">N</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport.next_hop">next_hop() (RNS.Transport static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Transport.next_hop_interface">next_hop_interface() (RNS.Transport static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.no_inbound_for">no_inbound_for() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.no_outbound_for">no_outbound_for() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="P">P</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Packet">Packet (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt">PacketReceipt (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport.PATHFINDER_M">PATHFINDER_M (RNS.Transport attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Packet.PLAIN_MDU">PLAIN_MDU (RNS.Packet attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="R">R</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.recall">recall() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.recall_app_data">recall_app_data() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Transport.register_announce_handler">register_announce_handler() (RNS.Transport static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.register_request_handler">register_request_handler() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.request">request() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport.request_path">request_path() (RNS.Transport static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RequestReceipt">RequestReceipt (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Packet.resend">resend() (RNS.Packet method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource">Resource (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum">Reticulum (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="S">S</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Packet.send">send() (RNS.Packet method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.set_default_app_data">set_default_app_data() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.set_delivery_callback">set_delivery_callback() (RNS.PacketReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.set_link_established_callback">set_link_established_callback() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.set_packet_callback">set_packet_callback() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Link.set_packet_callback">(RNS.Link method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="reference.html#RNS.Destination.set_proof_requested_callback">set_proof_requested_callback() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.set_proof_strategy">set_proof_strategy() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.set_remote_identified_callback">set_remote_identified_callback() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.set_resource_callback">set_resource_callback() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.set_resource_concluded_callback">set_resource_concluded_callback() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.set_resource_started_callback">set_resource_started_callback() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.set_resource_strategy">set_resource_strategy() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.set_timeout">set_timeout() (RNS.PacketReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.set_timeout_callback">set_timeout_callback() (RNS.PacketReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum.should_use_implicit_proof">should_use_implicit_proof() (RNS.Reticulum static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.sign">sign() (RNS.Destination method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Identity.sign">(RNS.Identity method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="T">T</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.teardown">teardown() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.to_file">to_file() (RNS.Identity method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Transport">Transport (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Reticulum.transport_enabled">transport_enabled() (RNS.Reticulum static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.truncated_hash">truncated_hash() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.TRUNCATED_HASHLENGTH">TRUNCATED_HASHLENGTH (RNS.Identity attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="V">V</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.validate">validate() (RNS.Identity method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="#" title="General Index"
|
|
>index</a></li>
|
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.6 beta documentation</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2021, Mark Qvist.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.1.
|
|
</div>
|
|
</body>
|
|
</html> |