mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-12-15 02:44:33 -05:00
786 lines
34 KiB
HTML
786 lines
34 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="en">
|
|
<head><meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
|
|
|
|
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29.dev1"/><title>Index - Reticulum Network Stack 0.8.6 beta documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=189ec851f9bb375a2509b67be1f64f0cf212b702" />
|
|
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
|
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
|
|
|
|
|
|
|
|
|
|
<style>
|
|
body {
|
|
--color-code-background: #f8f8f8;
|
|
--color-code-foreground: black;
|
|
|
|
}
|
|
@media not print {
|
|
body[data-theme="dark"] {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
--color-background-primary: #202b38;
|
|
--color-background-secondary: #161f27;
|
|
--color-foreground-primary: #dbdbdb;
|
|
--color-foreground-secondary: #a9b1ba;
|
|
--color-brand-primary: #41adff;
|
|
--color-background-hover: #161f27;
|
|
--color-api-name: #ffbe85;
|
|
--color-api-pre-name: #efae75;
|
|
|
|
}
|
|
@media (prefers-color-scheme: dark) {
|
|
body:not([data-theme="light"]) {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
--color-background-primary: #202b38;
|
|
--color-background-secondary: #161f27;
|
|
--color-foreground-primary: #dbdbdb;
|
|
--color-foreground-secondary: #a9b1ba;
|
|
--color-brand-primary: #41adff;
|
|
--color-background-hover: #161f27;
|
|
--color-api-name: #ffbe85;
|
|
--color-api-pre-name: #efae75;
|
|
|
|
}
|
|
}
|
|
}
|
|
</style></head>
|
|
<body>
|
|
|
|
<script>
|
|
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
</script>
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
<title>Contents</title>
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
<title>Menu</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
<title>Expand</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
<title>Light mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
<circle cx="12" cy="12" r="5"></circle>
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
<title>Dark mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
|
<title>Auto light/dark mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
|
<circle cx="12" cy="12" r="9" />
|
|
<path d="M13 12h5" />
|
|
<path d="M13 15h4" />
|
|
<path d="M13 18h1" />
|
|
<path d="M13 9h4" />
|
|
<path d="M13 6h1" />
|
|
</svg>
|
|
</symbol>
|
|
</svg>
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
<label class="overlay sidebar-overlay" for="__navigation">
|
|
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
</label>
|
|
<label class="overlay toc-overlay" for="__toc">
|
|
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
</label>
|
|
|
|
|
|
|
|
<div class="page">
|
|
<header class="mobile-header">
|
|
<div class="header-left">
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
<div class="header-center">
|
|
<a href="index.html"><div class="brand">Reticulum Network Stack 0.8.6 beta documentation</div></a>
|
|
</div>
|
|
<div class="header-right">
|
|
<div class="theme-toggle-container theme-toggle-header">
|
|
<button class="theme-toggle">
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<aside class="sidebar-drawer">
|
|
<div class="sidebar-container">
|
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
|
|
|
<div class="sidebar-logo-container">
|
|
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
|
|
</div>
|
|
|
|
<span class="sidebar-brand-text">Reticulum Network Stack 0.8.6 beta documentation</span>
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
|
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
<input type="hidden" name="area" value="default">
|
|
</form>
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="whatis.html">What is Reticulum?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="using.html">Using Reticulum on Your System</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</aside>
|
|
<div class="main">
|
|
<div class="content">
|
|
<div class="article-container">
|
|
<a href="#" class="back-to-top muted-link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
</svg>
|
|
<span>Back to top</span>
|
|
</a>
|
|
<div class="content-icon-container">
|
|
<div class="theme-toggle-container theme-toggle-content">
|
|
<button class="theme-toggle">
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
<article role="main">
|
|
|
|
<section class="genindex-section">
|
|
<h1 id="index">Index</h1>
|
|
<div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</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="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a></div>
|
|
</section>
|
|
<section id="_" class="genindex-section">
|
|
<h2>_</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.RawChannelReader.__init__">__init__() (RNS.RawChannelReader method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.RawChannelWriter.__init__">(RNS.RawChannelWriter method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="A" class="genindex-section">
|
|
<h2>A</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.accepts_links">accepts_links() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Channel.Channel.add_message_handler">add_message_handler() (RNS.Channel.Channel method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RawChannelReader.add_ready_callback">add_ready_callback() (RNS.RawChannelReader method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Resource.advertise">advertise() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.announce">announce() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum.ANNOUNCE_CAP">ANNOUNCE_CAP (RNS.Reticulum attribute)</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>
|
|
</section>
|
|
|
|
<section id="B" class="genindex-section">
|
|
<h2>B</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Buffer">Buffer (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="C" class="genindex-section">
|
|
<h2>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.Channel.Channel">Channel (class in RNS.Channel)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.clear_default_app_data">clear_default_app_data() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RequestReceipt.concluded">concluded() (RNS.RequestReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Buffer.create_bidirectional_buffer">create_bidirectional_buffer() (RNS.Buffer static 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.Buffer.create_reader">create_reader() (RNS.Buffer static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Buffer.create_writer">create_writer() (RNS.Buffer static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.current_ratchet_id">current_ratchet_id() (RNS.Identity static 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>
|
|
</section>
|
|
|
|
<section id="D" class="genindex-section">
|
|
<h2>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>
|
|
</section>
|
|
|
|
<section id="E" class="genindex-section">
|
|
<h2>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.enable_ratchets">enable_ratchets() (RNS.Destination method)</a>
|
|
</li>
|
|
<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.Destination.enforce_ratchets">enforce_ratchets() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.ESTABLISHMENT_TIMEOUT_PER_HOP">ESTABLISHMENT_TIMEOUT_PER_HOP (RNS.Link attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.expand_name">expand_name() (RNS.Destination static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="F" class="genindex-section">
|
|
<h2>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>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.from_file">from_file() (RNS.Identity static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.full_hash">full_hash() (RNS.Identity static method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="G" class="genindex-section">
|
|
<h2>G</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.get_age">get_age() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.get_channel">get_channel() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource.get_data_size">get_data_size() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.get_establishment_rate">get_establishment_rate() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource.get_hash">get_hash() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum.get_instance">get_instance() (RNS.Reticulum static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource.get_parts">get_parts() (RNS.Resource method)</a>
|
|
</li>
|
|
<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.Link.get_q">get_q() (RNS.Link method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Packet.get_q">(RNS.Packet method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Identity.get_random_hash">get_random_hash() (RNS.Identity static method)</a>
|
|
</li>
|
|
<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.Link.get_rssi">get_rssi() (RNS.Link method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Packet.get_rssi">(RNS.Packet method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="reference.html#RNS.PacketReceipt.get_rtt">get_rtt() (RNS.PacketReceipt method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource.get_segments">get_segments() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.get_snr">get_snr() (RNS.Link method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Packet.get_snr">(RNS.Packet method)</a>
|
|
</li>
|
|
</ul></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>
|
|
<li><a href="reference.html#RNS.Resource.get_transfer_size">get_transfer_size() (RNS.Resource method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="H" class="genindex-section">
|
|
<h2>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>
|
|
</section>
|
|
|
|
<section id="I" class="genindex-section">
|
|
<h2>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>
|
|
<li><a href="reference.html#RNS.Identity">Identity (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Link.inactive_for">inactive_for() (RNS.Link method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Resource.is_compressed">is_compressed() (RNS.Resource method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Channel.Channel.is_ready_to_send">is_ready_to_send() (RNS.Channel.Channel method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="K" class="genindex-section">
|
|
<h2>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.Link.KEEPALIVE_TIMEOUT_FACTOR">KEEPALIVE_TIMEOUT_FACTOR (RNS.Link attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.KEYSIZE">KEYSIZE (RNS.Identity attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="L" class="genindex-section">
|
|
<h2>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>
|
|
</section>
|
|
|
|
<section id="M" class="genindex-section">
|
|
<h2>M</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Channel.Channel.MDU">MDU (RNS.Channel.Channel property)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.MessageBase">MessageBase (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Reticulum.MINIMUM_BITRATE">MINIMUM_BITRATE (RNS.Reticulum attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.MessageBase.MSGTYPE">MSGTYPE (RNS.MessageBase attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum.MTU">MTU (RNS.Reticulum attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="N" class="genindex-section">
|
|
<h2>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_data_for">no_data_for() (RNS.Link method)</a>
|
|
</li>
|
|
<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>
|
|
</section>
|
|
|
|
<section id="P" class="genindex-section">
|
|
<h2>P</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.MessageBase.pack">pack() (RNS.MessageBase method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Packet">Packet (class in RNS)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.PacketReceipt">PacketReceipt (class in RNS)</a>
|
|
</li>
|
|
<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>
|
|
</section>
|
|
|
|
<section id="R" class="genindex-section">
|
|
<h2>R</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.RATCHET_COUNT">RATCHET_COUNT (RNS.Destination attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.RATCHET_EXPIRY">RATCHET_EXPIRY (RNS.Identity attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Destination.RATCHET_INTERVAL">RATCHET_INTERVAL (RNS.Destination attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Identity.RATCHETSIZE">RATCHETSIZE (RNS.Identity attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RawChannelReader">RawChannelReader (class in RNS)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RawChannelWriter">RawChannelWriter (class in RNS)</a>
|
|
</li>
|
|
<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.Channel.Channel.register_message_type">register_message_type() (RNS.Channel.Channel method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Destination.register_request_handler">register_request_handler() (RNS.Destination method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Reticulum.remote_management_enabled">remote_management_enabled() (RNS.Reticulum static method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Channel.Channel.remove_message_handler">remove_message_handler() (RNS.Channel.Channel method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.RawChannelReader.remove_ready_callback">remove_ready_callback() (RNS.RawChannelReader method)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.request">request() (RNS.Link method)</a>
|
|
</li>
|
|
<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>
|
|
</section>
|
|
|
|
<section id="S" class="genindex-section">
|
|
<h2>S</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Channel.Channel.send">send() (RNS.Channel.Channel method)</a>
|
|
|
|
<ul>
|
|
<li><a href="reference.html#RNS.Packet.send">(RNS.Packet method)</a>
|
|
</li>
|
|
</ul></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.Link.set_link_closed_callback">set_link_closed_callback() (RNS.Link 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.Destination.set_ratchet_interval">set_ratchet_interval() (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.Destination.set_retained_ratchets">set_retained_ratchets() (RNS.Destination 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>
|
|
<li><a href="reference.html#RNS.Link.STALE_GRACE">STALE_GRACE (RNS.Link attribute)</a>
|
|
</li>
|
|
<li><a href="reference.html#RNS.Link.STALE_TIME">STALE_TIME (RNS.Link attribute)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="T" class="genindex-section">
|
|
<h2>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.Link.track_phy_stats">track_phy_stats() (RNS.Link method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.Transport">Transport (class in RNS)</a>
|
|
</li>
|
|
<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>
|
|
</section>
|
|
|
|
<section id="U" class="genindex-section">
|
|
<h2>U</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="reference.html#RNS.MessageBase.unpack">unpack() (RNS.MessageBase method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
</section>
|
|
|
|
<section id="V" class="genindex-section">
|
|
<h2>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>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
</div>
|
|
<div class="bottom-of-page">
|
|
<div class="left-details">
|
|
<div class="copyright">
|
|
Copyright © 2023, Mark Qvist
|
|
</div>
|
|
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
|
|
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
|
|
</div>
|
|
<div class="right-details">
|
|
<div class="icons">
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
<aside class="toc-drawer no-toc">
|
|
|
|
|
|
|
|
</aside>
|
|
</div>
|
|
</div><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/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<script src="_static/sphinx_highlight.js"></script>
|
|
<script src="_static/scripts/furo.js"></script>
|
|
<script src="_static/clipboard.min.js"></script>
|
|
<script src="_static/copybutton.js"></script>
|
|
</body>
|
|
</html> |