/ docs / manual / genindex.html
genindex.html
  1  <!doctype html>
  2  <html class="no-js" lang="en" data-content_root="./">
  3    <head><meta charset="utf-8">
  4      <meta name="viewport" content="width=device-width,initial-scale=1">
  5      <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#"><link rel="search" title="Search" href="search.html">
  6          <link rel="prefetch" href="_static/rns_logo_512.png" as="image">
  7  
  8      <!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25.dev1 --><title>Index - Reticulum Network Stack 1.1.3 documentation</title>
  9  <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
 10      <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=580074bf" />
 11      <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
 12      <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
 13      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=bb3cebc5" />
 14      
 15      
 16  
 17  
 18  <style>
 19    body {
 20      --color-code-background: #f2f2f2;
 21    --color-code-foreground: #1e1e1e;
 22    
 23    }
 24    @media not print {
 25      body[data-theme="dark"] {
 26        --color-code-background: #202020;
 27    --color-code-foreground: #d0d0d0;
 28    --color-background-primary: #202b38;
 29    --color-background-secondary: #161f27;
 30    --color-foreground-primary: #dbdbdb;
 31    --color-foreground-secondary: #a9b1ba;
 32    --color-brand-primary: #41adff;
 33    --color-background-hover: #161f27;
 34    --color-api-name: #ffbe85;
 35    --color-api-pre-name: #efae75;
 36    
 37      }
 38      @media (prefers-color-scheme: dark) {
 39        body:not([data-theme="light"]) {
 40          --color-code-background: #202020;
 41    --color-code-foreground: #d0d0d0;
 42    --color-background-primary: #202b38;
 43    --color-background-secondary: #161f27;
 44    --color-foreground-primary: #dbdbdb;
 45    --color-foreground-secondary: #a9b1ba;
 46    --color-brand-primary: #41adff;
 47    --color-background-hover: #161f27;
 48    --color-api-name: #ffbe85;
 49    --color-api-pre-name: #efae75;
 50    
 51        }
 52      }
 53    }
 54  </style></head>
 55    <body>
 56      
 57      <script>
 58        document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 59      </script>
 60      
 61  
 62  <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 63    <symbol id="svg-toc" viewBox="0 0 24 24">
 64      <title>Contents</title>
 65      <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 66        <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"/>
 67      </svg>
 68    </symbol>
 69    <symbol id="svg-menu" viewBox="0 0 24 24">
 70      <title>Menu</title>
 71      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 72        stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 73        <line x1="3" y1="12" x2="21" y2="12"></line>
 74        <line x1="3" y1="6" x2="21" y2="6"></line>
 75        <line x1="3" y1="18" x2="21" y2="18"></line>
 76      </svg>
 77    </symbol>
 78    <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 79      <title>Expand</title>
 80      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 81        stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 82        <polyline points="9 18 15 12 9 6"></polyline>
 83      </svg>
 84    </symbol>
 85    <symbol id="svg-sun" viewBox="0 0 24 24">
 86      <title>Light mode</title>
 87      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 88        stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 89        <circle cx="12" cy="12" r="5"></circle>
 90        <line x1="12" y1="1" x2="12" y2="3"></line>
 91        <line x1="12" y1="21" x2="12" y2="23"></line>
 92        <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 93        <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 94        <line x1="1" y1="12" x2="3" y2="12"></line>
 95        <line x1="21" y1="12" x2="23" y2="12"></line>
 96        <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 97        <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 98      </svg>
 99    </symbol>
100    <symbol id="svg-moon" viewBox="0 0 24 24">
101      <title>Dark mode</title>
102      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
103        stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
104        <path stroke="none" d="M0 0h24v24H0z" fill="none" />
105        <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" />
106      </svg>
107    </symbol>
108    <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
109      <title>Auto light/dark, in light mode</title>
110      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
111        stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
112        class="icon-custom-derived-from-feather-sun-and-tabler-moon">
113        <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
114        <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
115        <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
116        <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
117        <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
118        <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
119        <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
120        <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
121        <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
122        <circle cx="14.5" cy="9.55" r="3.6"/>
123      </svg>
124    </symbol>
125    <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
126      <title>Auto light/dark, in dark mode</title>
127      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
128        stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
129        class="icon-custom-derived-from-feather-sun-and-tabler-moon">
130        <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
131        <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
132        <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
133        <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
134        <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
135        <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
136        <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
137        <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
138        <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
139        <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
140      </svg>
141    </symbol>
142    <symbol id="svg-pencil" viewBox="0 0 24 24">
143      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
144        stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
145        <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
146        <path d="M13.5 6.5l4 4" />
147        <path d="M20 21l2 -2l-2 -2" />
148        <path d="M17 17l-2 2l2 2" />
149      </svg>
150    </symbol>
151    <symbol id="svg-eye" viewBox="0 0 24 24">
152      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
153        stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
154        <path stroke="none" d="M0 0h24v24H0z" fill="none" />
155        <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
156        <path
157          d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
158        <path d="M20 21l2 -2l-2 -2" />
159        <path d="M17 17l-2 2l2 2" />
160      </svg>
161    </symbol>
162  </svg>
163  
164  <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
165  <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
166  <label class="overlay sidebar-overlay" for="__navigation"></label>
167  <label class="overlay toc-overlay" for="__toc"></label>
168  
169  <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
170  
171  
172  
173  <div class="page">
174    <header class="mobile-header">
175      <div class="header-left">
176        <label class="nav-overlay-icon" for="__navigation">
177          <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
178        </label>
179      </div>
180      <div class="header-center">
181        <a href="index.html"><div class="brand">Reticulum Network Stack 1.1.3 documentation</div></a>
182      </div>
183      <div class="header-right">
184        <div class="theme-toggle-container theme-toggle-header">
185          <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
186            <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
187            <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
188            <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
189            <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
190          </button>
191        </div>
192        <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
193          <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
194        </label>
195      </div>
196    </header>
197    <aside class="sidebar-drawer">
198      <div class="sidebar-container">
199        
200        <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
201    <div class="sidebar-logo-container">
202      <img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
203    </div>
204    
205    <span class="sidebar-brand-text">Reticulum Network Stack 1.1.3 documentation</span>
206    
207  </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
208    <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
209    <input type="hidden" name="check_keywords" value="yes">
210    <input type="hidden" name="area" value="default">
211  </form>
212  <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
213    <ul>
214  <li class="toctree-l1"><a class="reference internal" href="whatis.html">What is Reticulum?</a></li>
215  <li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a></li>
216  <li class="toctree-l1"><a class="reference internal" href="zen.html">Zen of Reticulum</a></li>
217  <li class="toctree-l1"><a class="reference internal" href="software.html">Programs Using Reticulum</a></li>
218  <li class="toctree-l1"><a class="reference internal" href="using.html">Using Reticulum on Your System</a></li>
219  <li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a></li>
220  <li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a></li>
221  <li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a></li>
222  <li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a></li>
223  <li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a></li>
224  <li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
225  <li class="toctree-l1"><a class="reference internal" href="license.html">Reticulum License</a></li>
226  </ul>
227  <ul>
228  <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
229  </ul>
230  
231  </div>
232  </div>
233  
234        </div>
235        
236      </div>
237    </aside>
238    <div class="main">
239      <div class="content">
240        <div class="article-container">
241          <a href="#" class="back-to-top muted-link">
242            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
243              <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
244            </svg>
245            <span>Back to top</span>
246          </a>
247          <div class="content-icon-container">
248            <div class="theme-toggle-container theme-toggle-content">
249              <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
250                <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
251                <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
252                <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
253                <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
254              </button>
255            </div>
256            <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
257              <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
258            </label>
259          </div>
260          <article role="main" id="furo-main-content">
261            
262  <section class="genindex-section">
263    <h1 id="index">Index</h1>
264    <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>
265  </section>
266  <section id="_" class="genindex-section">
267    <h2>_</h2>
268    <table style="width: 100%" class="indextable genindextable"><tr>
269      <td style="width: 33%; vertical-align: top;"><ul>
270          <li><a href="reference.html#RNS.RawChannelReader.__init__">__init__() (RNS.RawChannelReader method)</a>
271  
272          <ul>
273            <li><a href="reference.html#RNS.RawChannelWriter.__init__">(RNS.RawChannelWriter method)</a>
274  </li>
275          </ul></li>
276      </ul></td>
277    </tr></table>
278  </section>
279  
280  <section id="A" class="genindex-section">
281    <h2>A</h2>
282    <table style="width: 100%" class="indextable genindextable"><tr>
283      <td style="width: 33%; vertical-align: top;"><ul>
284          <li><a href="reference.html#RNS.Destination.accepts_links">accepts_links() (RNS.Destination method)</a>
285  </li>
286          <li><a href="reference.html#RNS.Channel.Channel.add_message_handler">add_message_handler() (RNS.Channel.Channel method)</a>
287  </li>
288          <li><a href="reference.html#RNS.RawChannelReader.add_ready_callback">add_ready_callback() (RNS.RawChannelReader method)</a>
289  </li>
290          <li><a href="reference.html#RNS.Resource.advertise">advertise() (RNS.Resource method)</a>
291  </li>
292      </ul></td>
293      <td style="width: 33%; vertical-align: top;"><ul>
294          <li><a href="reference.html#RNS.Destination.announce">announce() (RNS.Destination method)</a>
295  </li>
296          <li><a href="reference.html#RNS.Reticulum.ANNOUNCE_CAP">ANNOUNCE_CAP (RNS.Reticulum attribute)</a>
297  </li>
298          <li><a href="reference.html#RNS.Destination.app_and_aspects_from_name">app_and_aspects_from_name() (RNS.Destination static method)</a>
299  </li>
300          <li><a href="reference.html#RNS.Transport.await_path">await_path() (RNS.Transport static method)</a>
301  </li>
302      </ul></td>
303    </tr></table>
304  </section>
305  
306  <section id="B" class="genindex-section">
307    <h2>B</h2>
308    <table style="width: 100%" class="indextable genindextable"><tr>
309      <td style="width: 33%; vertical-align: top;"><ul>
310          <li><a href="reference.html#RNS.Reticulum.blackhole_sources">blackhole_sources() (RNS.Reticulum static method)</a>
311  </li>
312      </ul></td>
313      <td style="width: 33%; vertical-align: top;"><ul>
314          <li><a href="reference.html#RNS.Buffer">Buffer (class in RNS)</a>
315  </li>
316      </ul></td>
317    </tr></table>
318  </section>
319  
320  <section id="C" class="genindex-section">
321    <h2>C</h2>
322    <table style="width: 100%" class="indextable genindextable"><tr>
323      <td style="width: 33%; vertical-align: top;"><ul>
324          <li><a href="reference.html#RNS.Resource.cancel">cancel() (RNS.Resource method)</a>
325  </li>
326          <li><a href="reference.html#RNS.Channel.Channel">Channel (class in RNS.Channel)</a>
327  </li>
328          <li><a href="reference.html#RNS.Destination.clear_default_app_data">clear_default_app_data() (RNS.Destination method)</a>
329  </li>
330          <li><a href="reference.html#RNS.RequestReceipt.concluded">concluded() (RNS.RequestReceipt method)</a>
331  </li>
332          <li><a href="reference.html#RNS.Buffer.create_bidirectional_buffer">create_bidirectional_buffer() (RNS.Buffer static method)</a>
333  </li>
334      </ul></td>
335      <td style="width: 33%; vertical-align: top;"><ul>
336          <li><a href="reference.html#RNS.Destination.create_keys">create_keys() (RNS.Destination method)</a>
337  </li>
338          <li><a href="reference.html#RNS.Buffer.create_reader">create_reader() (RNS.Buffer static method)</a>
339  </li>
340          <li><a href="reference.html#RNS.Buffer.create_writer">create_writer() (RNS.Buffer static method)</a>
341  </li>
342          <li><a href="reference.html#RNS.Identity.current_ratchet_id">current_ratchet_id() (RNS.Identity static method)</a>
343  </li>
344          <li><a href="reference.html#RNS.Identity.CURVE">CURVE (RNS.Identity attribute)</a>
345  
346          <ul>
347            <li><a href="reference.html#RNS.Link.CURVE">(RNS.Link attribute)</a>
348  </li>
349          </ul></li>
350      </ul></td>
351    </tr></table>
352  </section>
353  
354  <section id="D" class="genindex-section">
355    <h2>D</h2>
356    <table style="width: 100%" class="indextable genindextable"><tr>
357      <td style="width: 33%; vertical-align: top;"><ul>
358          <li><a href="reference.html#RNS.Destination.decrypt">decrypt() (RNS.Destination method)</a>
359  
360          <ul>
361            <li><a href="reference.html#RNS.Identity.decrypt">(RNS.Identity method)</a>
362  </li>
363          </ul></li>
364          <li><a href="reference.html#RNS.Transport.deregister_announce_handler">deregister_announce_handler() (RNS.Transport static method)</a>
365  </li>
366      </ul></td>
367      <td style="width: 33%; vertical-align: top;"><ul>
368          <li><a href="reference.html#RNS.Destination.deregister_request_handler">deregister_request_handler() (RNS.Destination method)</a>
369  </li>
370          <li><a href="reference.html#RNS.Destination">Destination (class in RNS)</a>
371  </li>
372          <li><a href="reference.html#RNS.Reticulum.discovered_interfaces">discovered_interfaces() (RNS.Reticulum static method)</a>
373  </li>
374      </ul></td>
375    </tr></table>
376  </section>
377  
378  <section id="E" class="genindex-section">
379    <h2>E</h2>
380    <table style="width: 100%" class="indextable genindextable"><tr>
381      <td style="width: 33%; vertical-align: top;"><ul>
382          <li><a href="reference.html#RNS.Destination.enable_ratchets">enable_ratchets() (RNS.Destination method)</a>
383  </li>
384          <li><a href="reference.html#RNS.Destination.encrypt">encrypt() (RNS.Destination method)</a>
385  
386          <ul>
387            <li><a href="reference.html#RNS.Identity.encrypt">(RNS.Identity method)</a>
388  </li>
389          </ul></li>
390      </ul></td>
391      <td style="width: 33%; vertical-align: top;"><ul>
392          <li><a href="reference.html#RNS.Packet.ENCRYPTED_MDU">ENCRYPTED_MDU (RNS.Packet attribute)</a>
393  </li>
394          <li><a href="reference.html#RNS.Destination.enforce_ratchets">enforce_ratchets() (RNS.Destination method)</a>
395  </li>
396          <li><a href="reference.html#RNS.Link.ESTABLISHMENT_TIMEOUT_PER_HOP">ESTABLISHMENT_TIMEOUT_PER_HOP (RNS.Link attribute)</a>
397  </li>
398          <li><a href="reference.html#RNS.Destination.expand_name">expand_name() (RNS.Destination static method)</a>
399  </li>
400      </ul></td>
401    </tr></table>
402  </section>
403  
404  <section id="F" class="genindex-section">
405    <h2>F</h2>
406    <table style="width: 100%" class="indextable genindextable"><tr>
407      <td style="width: 33%; vertical-align: top;"><ul>
408          <li><a href="reference.html#RNS.Identity.from_bytes">from_bytes() (RNS.Identity static method)</a>
409  </li>
410      </ul></td>
411      <td style="width: 33%; vertical-align: top;"><ul>
412          <li><a href="reference.html#RNS.Identity.from_file">from_file() (RNS.Identity static method)</a>
413  </li>
414          <li><a href="reference.html#RNS.Identity.full_hash">full_hash() (RNS.Identity static method)</a>
415  </li>
416      </ul></td>
417    </tr></table>
418  </section>
419  
420  <section id="G" class="genindex-section">
421    <h2>G</h2>
422    <table style="width: 100%" class="indextable genindextable"><tr>
423      <td style="width: 33%; vertical-align: top;"><ul>
424          <li><a href="reference.html#RNS.Link.get_age">get_age() (RNS.Link method)</a>
425  </li>
426          <li><a href="reference.html#RNS.Link.get_channel">get_channel() (RNS.Link method)</a>
427  </li>
428          <li><a href="reference.html#RNS.Resource.get_data_size">get_data_size() (RNS.Resource method)</a>
429  </li>
430          <li><a href="reference.html#RNS.Link.get_establishment_rate">get_establishment_rate() (RNS.Link method)</a>
431  </li>
432          <li><a href="reference.html#RNS.Link.get_expected_rate">get_expected_rate() (RNS.Link method)</a>
433  </li>
434          <li><a href="reference.html#RNS.Resource.get_hash">get_hash() (RNS.Resource method)</a>
435  </li>
436          <li><a href="reference.html#RNS.Reticulum.get_instance">get_instance() (RNS.Reticulum static method)</a>
437  </li>
438          <li><a href="reference.html#RNS.Link.get_mdu">get_mdu() (RNS.Link method)</a>
439  </li>
440          <li><a href="reference.html#RNS.Link.get_mode">get_mode() (RNS.Link method)</a>
441  </li>
442          <li><a href="reference.html#RNS.Link.get_mtu">get_mtu() (RNS.Link method)</a>
443  </li>
444          <li><a href="reference.html#RNS.Resource.get_parts">get_parts() (RNS.Resource method)</a>
445  </li>
446          <li><a href="reference.html#RNS.Destination.get_private_key">get_private_key() (RNS.Destination method)</a>
447  
448          <ul>
449            <li><a href="reference.html#RNS.Identity.get_private_key">(RNS.Identity method)</a>
450  </li>
451          </ul></li>
452          <li><a href="reference.html#RNS.RequestReceipt.get_progress">get_progress() (RNS.RequestReceipt method)</a>
453  
454          <ul>
455            <li><a href="reference.html#RNS.Resource.get_progress">(RNS.Resource method)</a>
456  </li>
457          </ul></li>
458          <li><a href="reference.html#RNS.Identity.get_public_key">get_public_key() (RNS.Identity method)</a>
459  </li>
460      </ul></td>
461      <td style="width: 33%; vertical-align: top;"><ul>
462          <li><a href="reference.html#RNS.Link.get_q">get_q() (RNS.Link method)</a>
463  
464          <ul>
465            <li><a href="reference.html#RNS.Packet.get_q">(RNS.Packet method)</a>
466  </li>
467          </ul></li>
468          <li><a href="reference.html#RNS.Identity.get_random_hash">get_random_hash() (RNS.Identity static method)</a>
469  </li>
470          <li><a href="reference.html#RNS.Link.get_remote_identity">get_remote_identity() (RNS.Link method)</a>
471  </li>
472          <li><a href="reference.html#RNS.RequestReceipt.get_request_id">get_request_id() (RNS.RequestReceipt method)</a>
473  </li>
474          <li><a href="reference.html#RNS.RequestReceipt.get_response">get_response() (RNS.RequestReceipt method)</a>
475  </li>
476          <li><a href="reference.html#RNS.RequestReceipt.get_response_time">get_response_time() (RNS.RequestReceipt method)</a>
477  </li>
478          <li><a href="reference.html#RNS.Link.get_rssi">get_rssi() (RNS.Link method)</a>
479  
480          <ul>
481            <li><a href="reference.html#RNS.Packet.get_rssi">(RNS.Packet method)</a>
482  </li>
483          </ul></li>
484          <li><a href="reference.html#RNS.PacketReceipt.get_rtt">get_rtt() (RNS.PacketReceipt method)</a>
485  </li>
486          <li><a href="reference.html#RNS.Resource.get_segments">get_segments() (RNS.Resource method)</a>
487  </li>
488          <li><a href="reference.html#RNS.Link.get_snr">get_snr() (RNS.Link method)</a>
489  
490          <ul>
491            <li><a href="reference.html#RNS.Packet.get_snr">(RNS.Packet method)</a>
492  </li>
493          </ul></li>
494          <li><a href="reference.html#RNS.PacketReceipt.get_status">get_status() (RNS.PacketReceipt method)</a>
495  
496          <ul>
497            <li><a href="reference.html#RNS.RequestReceipt.get_status">(RNS.RequestReceipt method)</a>
498  </li>
499          </ul></li>
500          <li><a href="reference.html#RNS.Resource.get_transfer_size">get_transfer_size() (RNS.Resource method)</a>
501  </li>
502      </ul></td>
503    </tr></table>
504  </section>
505  
506  <section id="H" class="genindex-section">
507    <h2>H</h2>
508    <table style="width: 100%" class="indextable genindextable"><tr>
509      <td style="width: 33%; vertical-align: top;"><ul>
510          <li><a href="reference.html#RNS.Transport.has_path">has_path() (RNS.Transport static method)</a>
511  </li>
512          <li><a href="reference.html#RNS.Destination.hash">hash() (RNS.Destination static method)</a>
513  </li>
514      </ul></td>
515      <td style="width: 33%; vertical-align: top;"><ul>
516          <li><a href="reference.html#RNS.Destination.hash_from_name_and_identity">hash_from_name_and_identity() (RNS.Destination static method)</a>
517  </li>
518          <li><a href="reference.html#RNS.Transport.hops_to">hops_to() (RNS.Transport static method)</a>
519  </li>
520      </ul></td>
521    </tr></table>
522  </section>
523  
524  <section id="I" class="genindex-section">
525    <h2>I</h2>
526    <table style="width: 100%" class="indextable genindextable"><tr>
527      <td style="width: 33%; vertical-align: top;"><ul>
528          <li><a href="reference.html#RNS.Link.identify">identify() (RNS.Link method)</a>
529  </li>
530          <li><a href="reference.html#RNS.Identity">Identity (class in RNS)</a>
531  </li>
532          <li><a href="reference.html#RNS.Link.inactive_for">inactive_for() (RNS.Link method)</a>
533  </li>
534      </ul></td>
535      <td style="width: 33%; vertical-align: top;"><ul>
536          <li><a href="reference.html#RNS.Reticulum.interface_discovery_sources">interface_discovery_sources() (RNS.Reticulum static method)</a>
537  </li>
538          <li><a href="reference.html#RNS.Resource.is_compressed">is_compressed() (RNS.Resource method)</a>
539  </li>
540          <li><a href="reference.html#RNS.Channel.Channel.is_ready_to_send">is_ready_to_send() (RNS.Channel.Channel method)</a>
541  </li>
542      </ul></td>
543    </tr></table>
544  </section>
545  
546  <section id="K" class="genindex-section">
547    <h2>K</h2>
548    <table style="width: 100%" class="indextable genindextable"><tr>
549      <td style="width: 33%; vertical-align: top;"><ul>
550          <li><a href="reference.html#RNS.Link.KEEPALIVE">KEEPALIVE (RNS.Link attribute)</a>
551  </li>
552      </ul></td>
553      <td style="width: 33%; vertical-align: top;"><ul>
554          <li><a href="reference.html#RNS.Link.KEEPALIVE_TIMEOUT_FACTOR">KEEPALIVE_TIMEOUT_FACTOR (RNS.Link attribute)</a>
555  </li>
556          <li><a href="reference.html#RNS.Identity.KEYSIZE">KEYSIZE (RNS.Identity attribute)</a>
557  </li>
558      </ul></td>
559    </tr></table>
560  </section>
561  
562  <section id="L" class="genindex-section">
563    <h2>L</h2>
564    <table style="width: 100%" class="indextable genindextable"><tr>
565      <td style="width: 33%; vertical-align: top;"><ul>
566          <li><a href="reference.html#RNS.Link">Link (class in RNS)</a>
567  </li>
568          <li><a href="reference.html#RNS.Reticulum.LINK_MTU_DISCOVERY">LINK_MTU_DISCOVERY (RNS.Reticulum attribute)</a>
569  </li>
570          <li><a href="reference.html#RNS.Reticulum.link_mtu_discovery">link_mtu_discovery() (RNS.Reticulum static method)</a>
571  </li>
572      </ul></td>
573      <td style="width: 33%; vertical-align: top;"><ul>
574          <li><a href="reference.html#RNS.Destination.load_private_key">load_private_key() (RNS.Destination method)</a>
575  
576          <ul>
577            <li><a href="reference.html#RNS.Identity.load_private_key">(RNS.Identity method)</a>
578  </li>
579          </ul></li>
580          <li><a href="reference.html#RNS.Identity.load_public_key">load_public_key() (RNS.Identity method)</a>
581  </li>
582      </ul></td>
583    </tr></table>
584  </section>
585  
586  <section id="M" class="genindex-section">
587    <h2>M</h2>
588    <table style="width: 100%" class="indextable genindextable"><tr>
589      <td style="width: 33%; vertical-align: top;"><ul>
590          <li><a href="reference.html#RNS.Channel.Channel.mdu">mdu (RNS.Channel.Channel property)</a>
591  </li>
592          <li><a href="reference.html#RNS.MessageBase">MessageBase (class in RNS)</a>
593  </li>
594      </ul></td>
595      <td style="width: 33%; vertical-align: top;"><ul>
596          <li><a href="reference.html#RNS.Reticulum.MINIMUM_BITRATE">MINIMUM_BITRATE (RNS.Reticulum attribute)</a>
597  </li>
598          <li><a href="reference.html#RNS.MessageBase.MSGTYPE">MSGTYPE (RNS.MessageBase attribute)</a>
599  </li>
600          <li><a href="reference.html#RNS.Reticulum.MTU">MTU (RNS.Reticulum attribute)</a>
601  </li>
602      </ul></td>
603    </tr></table>
604  </section>
605  
606  <section id="N" class="genindex-section">
607    <h2>N</h2>
608    <table style="width: 100%" class="indextable genindextable"><tr>
609      <td style="width: 33%; vertical-align: top;"><ul>
610          <li><a href="reference.html#RNS.Transport.next_hop">next_hop() (RNS.Transport static method)</a>
611  </li>
612          <li><a href="reference.html#RNS.Transport.next_hop_interface">next_hop_interface() (RNS.Transport static method)</a>
613  </li>
614      </ul></td>
615      <td style="width: 33%; vertical-align: top;"><ul>
616          <li><a href="reference.html#RNS.Link.no_data_for">no_data_for() (RNS.Link method)</a>
617  </li>
618          <li><a href="reference.html#RNS.Link.no_inbound_for">no_inbound_for() (RNS.Link method)</a>
619  </li>
620          <li><a href="reference.html#RNS.Link.no_outbound_for">no_outbound_for() (RNS.Link method)</a>
621  </li>
622      </ul></td>
623    </tr></table>
624  </section>
625  
626  <section id="P" class="genindex-section">
627    <h2>P</h2>
628    <table style="width: 100%" class="indextable genindextable"><tr>
629      <td style="width: 33%; vertical-align: top;"><ul>
630          <li><a href="reference.html#RNS.MessageBase.pack">pack() (RNS.MessageBase method)</a>
631  </li>
632          <li><a href="reference.html#RNS.Packet">Packet (class in RNS)</a>
633  </li>
634          <li><a href="reference.html#RNS.PacketReceipt">PacketReceipt (class in RNS)</a>
635  </li>
636      </ul></td>
637      <td style="width: 33%; vertical-align: top;"><ul>
638          <li><a href="reference.html#RNS.Transport.PATHFINDER_M">PATHFINDER_M (RNS.Transport attribute)</a>
639  </li>
640          <li><a href="reference.html#RNS.Packet.PLAIN_MDU">PLAIN_MDU (RNS.Packet attribute)</a>
641  </li>
642          <li><a href="reference.html#RNS.Reticulum.publish_blackhole_enabled">publish_blackhole_enabled() (RNS.Reticulum static method)</a>
643  </li>
644      </ul></td>
645    </tr></table>
646  </section>
647  
648  <section id="R" class="genindex-section">
649    <h2>R</h2>
650    <table style="width: 100%" class="indextable genindextable"><tr>
651      <td style="width: 33%; vertical-align: top;"><ul>
652          <li><a href="reference.html#RNS.Destination.RATCHET_COUNT">RATCHET_COUNT (RNS.Destination attribute)</a>
653  </li>
654          <li><a href="reference.html#RNS.Identity.RATCHET_EXPIRY">RATCHET_EXPIRY (RNS.Identity attribute)</a>
655  </li>
656          <li><a href="reference.html#RNS.Destination.RATCHET_INTERVAL">RATCHET_INTERVAL (RNS.Destination attribute)</a>
657  </li>
658          <li><a href="reference.html#RNS.Identity.RATCHETSIZE">RATCHETSIZE (RNS.Identity attribute)</a>
659  </li>
660          <li><a href="reference.html#RNS.RawChannelReader">RawChannelReader (class in RNS)</a>
661  </li>
662          <li><a href="reference.html#RNS.RawChannelWriter">RawChannelWriter (class in RNS)</a>
663  </li>
664          <li><a href="reference.html#RNS.Identity.recall">recall() (RNS.Identity static method)</a>
665  </li>
666          <li><a href="reference.html#RNS.Identity.recall_app_data">recall_app_data() (RNS.Identity static method)</a>
667  </li>
668          <li><a href="reference.html#RNS.Transport.register_announce_handler">register_announce_handler() (RNS.Transport static method)</a>
669  </li>
670          <li><a href="reference.html#RNS.Channel.Channel.register_message_type">register_message_type() (RNS.Channel.Channel method)</a>
671  </li>
672      </ul></td>
673      <td style="width: 33%; vertical-align: top;"><ul>
674          <li><a href="reference.html#RNS.Destination.register_request_handler">register_request_handler() (RNS.Destination method)</a>
675  </li>
676          <li><a href="reference.html#RNS.Reticulum.remote_management_enabled">remote_management_enabled() (RNS.Reticulum static method)</a>
677  </li>
678          <li><a href="reference.html#RNS.Channel.Channel.remove_message_handler">remove_message_handler() (RNS.Channel.Channel method)</a>
679  </li>
680          <li><a href="reference.html#RNS.RawChannelReader.remove_ready_callback">remove_ready_callback() (RNS.RawChannelReader method)</a>
681  </li>
682          <li><a href="reference.html#RNS.Link.request">request() (RNS.Link method)</a>
683  </li>
684          <li><a href="reference.html#RNS.Transport.request_path">request_path() (RNS.Transport static method)</a>
685  </li>
686          <li><a href="reference.html#RNS.RequestReceipt">RequestReceipt (class in RNS)</a>
687  </li>
688          <li><a href="reference.html#RNS.Reticulum.required_discovery_value">required_discovery_value() (RNS.Reticulum static method)</a>
689  </li>
690          <li><a href="reference.html#RNS.Packet.resend">resend() (RNS.Packet method)</a>
691  </li>
692          <li><a href="reference.html#RNS.Resource">Resource (class in RNS)</a>
693  </li>
694          <li><a href="reference.html#RNS.Reticulum">Reticulum (class in RNS)</a>
695  </li>
696      </ul></td>
697    </tr></table>
698  </section>
699  
700  <section id="S" class="genindex-section">
701    <h2>S</h2>
702    <table style="width: 100%" class="indextable genindextable"><tr>
703      <td style="width: 33%; vertical-align: top;"><ul>
704          <li><a href="reference.html#RNS.Channel.Channel.send">send() (RNS.Channel.Channel method)</a>
705  
706          <ul>
707            <li><a href="reference.html#RNS.Packet.send">(RNS.Packet method)</a>
708  </li>
709          </ul></li>
710          <li><a href="reference.html#RNS.Destination.set_default_app_data">set_default_app_data() (RNS.Destination method)</a>
711  </li>
712          <li><a href="reference.html#RNS.PacketReceipt.set_delivery_callback">set_delivery_callback() (RNS.PacketReceipt method)</a>
713  </li>
714          <li><a href="reference.html#RNS.Link.set_link_closed_callback">set_link_closed_callback() (RNS.Link method)</a>
715  </li>
716          <li><a href="reference.html#RNS.Destination.set_link_established_callback">set_link_established_callback() (RNS.Destination method)</a>
717  </li>
718          <li><a href="reference.html#RNS.Destination.set_packet_callback">set_packet_callback() (RNS.Destination method)</a>
719  
720          <ul>
721            <li><a href="reference.html#RNS.Link.set_packet_callback">(RNS.Link method)</a>
722  </li>
723          </ul></li>
724          <li><a href="reference.html#RNS.Destination.set_proof_requested_callback">set_proof_requested_callback() (RNS.Destination method)</a>
725  </li>
726          <li><a href="reference.html#RNS.Destination.set_proof_strategy">set_proof_strategy() (RNS.Destination method)</a>
727  </li>
728          <li><a href="reference.html#RNS.Destination.set_ratchet_interval">set_ratchet_interval() (RNS.Destination method)</a>
729  </li>
730          <li><a href="reference.html#RNS.Link.set_remote_identified_callback">set_remote_identified_callback() (RNS.Link method)</a>
731  </li>
732      </ul></td>
733      <td style="width: 33%; vertical-align: top;"><ul>
734          <li><a href="reference.html#RNS.Link.set_resource_callback">set_resource_callback() (RNS.Link method)</a>
735  </li>
736          <li><a href="reference.html#RNS.Link.set_resource_concluded_callback">set_resource_concluded_callback() (RNS.Link method)</a>
737  </li>
738          <li><a href="reference.html#RNS.Link.set_resource_started_callback">set_resource_started_callback() (RNS.Link method)</a>
739  </li>
740          <li><a href="reference.html#RNS.Link.set_resource_strategy">set_resource_strategy() (RNS.Link method)</a>
741  </li>
742          <li><a href="reference.html#RNS.Destination.set_retained_ratchets">set_retained_ratchets() (RNS.Destination method)</a>
743  </li>
744          <li><a href="reference.html#RNS.PacketReceipt.set_timeout">set_timeout() (RNS.PacketReceipt method)</a>
745  </li>
746          <li><a href="reference.html#RNS.PacketReceipt.set_timeout_callback">set_timeout_callback() (RNS.PacketReceipt method)</a>
747  </li>
748          <li><a href="reference.html#RNS.Reticulum.should_use_implicit_proof">should_use_implicit_proof() (RNS.Reticulum static method)</a>
749  </li>
750          <li><a href="reference.html#RNS.Destination.sign">sign() (RNS.Destination method)</a>
751  
752          <ul>
753            <li><a href="reference.html#RNS.Identity.sign">(RNS.Identity method)</a>
754  </li>
755          </ul></li>
756          <li><a href="reference.html#RNS.Link.STALE_GRACE">STALE_GRACE (RNS.Link attribute)</a>
757  </li>
758          <li><a href="reference.html#RNS.Link.STALE_TIME">STALE_TIME (RNS.Link attribute)</a>
759  </li>
760      </ul></td>
761    </tr></table>
762  </section>
763  
764  <section id="T" class="genindex-section">
765    <h2>T</h2>
766    <table style="width: 100%" class="indextable genindextable"><tr>
767      <td style="width: 33%; vertical-align: top;"><ul>
768          <li><a href="reference.html#RNS.Link.teardown">teardown() (RNS.Link method)</a>
769  </li>
770          <li><a href="reference.html#RNS.Identity.to_file">to_file() (RNS.Identity method)</a>
771  </li>
772          <li><a href="reference.html#RNS.Link.track_phy_stats">track_phy_stats() (RNS.Link method)</a>
773  </li>
774      </ul></td>
775      <td style="width: 33%; vertical-align: top;"><ul>
776          <li><a href="reference.html#RNS.Transport">Transport (class in RNS)</a>
777  </li>
778          <li><a href="reference.html#RNS.Reticulum.transport_enabled">transport_enabled() (RNS.Reticulum static method)</a>
779  </li>
780          <li><a href="reference.html#RNS.Identity.truncated_hash">truncated_hash() (RNS.Identity static method)</a>
781  </li>
782          <li><a href="reference.html#RNS.Identity.TRUNCATED_HASHLENGTH">TRUNCATED_HASHLENGTH (RNS.Identity attribute)</a>
783  </li>
784      </ul></td>
785    </tr></table>
786  </section>
787  
788  <section id="U" class="genindex-section">
789    <h2>U</h2>
790    <table style="width: 100%" class="indextable genindextable"><tr>
791      <td style="width: 33%; vertical-align: top;"><ul>
792          <li><a href="reference.html#RNS.MessageBase.unpack">unpack() (RNS.MessageBase method)</a>
793  </li>
794      </ul></td>
795    </tr></table>
796  </section>
797  
798  <section id="V" class="genindex-section">
799    <h2>V</h2>
800    <table style="width: 100%" class="indextable genindextable"><tr>
801      <td style="width: 33%; vertical-align: top;"><ul>
802          <li><a href="reference.html#RNS.Identity.validate">validate() (RNS.Identity method)</a>
803  </li>
804      </ul></td>
805    </tr></table>
806  </section>
807  
808  
809          </article>
810        </div>
811        <footer>
812          
813          <div class="related-pages">
814            
815            
816          </div>
817          <div class="bottom-of-page">
818            <div class="left-details">
819              <div class="copyright">
820                  Copyright &#169; 2025, Mark Qvist
821              </div>
822              Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and 
823              <a href="https://github.com/pradyunsg/furo">Furo</a>
824              
825            </div>
826            <div class="right-details">
827              
828            </div>
829          </div>
830          
831        </footer>
832      </div>
833      <aside class="toc-drawer no-toc">
834        
835        
836        
837      </aside>
838    </div>
839  </div><script src="_static/documentation_options.js?v=cb7bf70b"></script>
840      <script src="_static/doctools.js?v=9bcbadda"></script>
841      <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
842      <script src="_static/scripts/furo.js?v=46bd48cc"></script>
843      <script src="_static/clipboard.min.js?v=a7894cd8"></script>
844      <script src="_static/copybutton.js?v=f281be69"></script>
845      </body>
846  </html>