mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-06-08 06:01:55 -07:00
Added blackhole methods to API docs
This commit is contained in:
Mark Qvist
@@ -3405,6 +3405,14 @@ class Transport:
|
||||
|
||||
@staticmethod
|
||||
def blackhole_identity(identity_hash, until=None, reason=None):
|
||||
"""
|
||||
Blackholes an identity.
|
||||
|
||||
:param identity_hash: The identity hash to blackhole as *bytes*.
|
||||
:param until: Optional unix timestamp of when the blackhole expires as *float* or *int*.
|
||||
:param reason: Optional reason for the blackhole as *str*.
|
||||
:returns: *True* if successful, otherwise *False*.
|
||||
"""
|
||||
try:
|
||||
if not identity_hash in Transport.blackholed_identities:
|
||||
entry = {"source": Transport.identity.hash, "until": until, "reason": reason}
|
||||
@@ -3422,6 +3430,12 @@ class Transport:
|
||||
|
||||
@staticmethod
|
||||
def unblackhole_identity(identity_hash):
|
||||
"""
|
||||
Lifts blackhole for an identity.
|
||||
|
||||
:param identity_hash: The identity hash to blackhole as *bytes*.
|
||||
:returns: *True* if successful, otherwise *False*.
|
||||
"""
|
||||
try:
|
||||
if identity_hash in Transport.blackholed_identities:
|
||||
Transport.blackholed_identities.pop(identity_hash)
|
||||
|
||||
@@ -210,8 +210,8 @@ This is not about "dropping out" of society. It is about building a substrate on
|
||||
|
||||
**Consider:**
|
||||
|
||||
- **The Old Way:** "My connection is slow. I should call my ISP and complain."
|
||||
- **The Zen Way:** "The path is noisy. I will adjust the antenna or find a better route."
|
||||
- **The Old Way:** *"My connection is slow. I should call my ISP and complain."*
|
||||
- **The Zen Way:** *"The path is noisy. I will adjust the antenna or find a better route."*
|
||||
|
||||
By taking ownership of the infrastructure, you take ownership of your voice. You stop shouting into someone else's megaphone and start building your own. The network is no longer something that happens to you; it is something you make happen.
|
||||
|
||||
|
||||
@@ -309,10 +309,12 @@
|
||||
<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.Reticulum.blackhole_sources">blackhole_sources() (RNS.Reticulum static method)</a>
|
||||
<li><a href="reference.html#RNS.Transport.blackhole_identity">blackhole_identity() (RNS.Transport static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="reference.html#RNS.Reticulum.blackhole_sources">blackhole_sources() (RNS.Reticulum static method)</a>
|
||||
</li>
|
||||
<li><a href="reference.html#RNS.Buffer">Buffer (class in RNS)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
@@ -792,6 +794,10 @@
|
||||
<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.Transport.unblackhole_identity">unblackhole_identity() (RNS.Transport static method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="reference.html#RNS.MessageBase.unpack">unpack() (RNS.MessageBase method)</a>
|
||||
</li>
|
||||
|
||||
Binary file not shown.
@@ -2234,6 +2234,38 @@ will announce it.</p>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="RNS.Transport.blackhole_identity">
|
||||
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">blackhole_identity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identity_hash</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Transport.blackhole_identity" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Blackholes an identity.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>identity_hash</strong> – The identity hash to blackhole as <em>bytes</em>.</p></li>
|
||||
<li><p><strong>until</strong> – Optional unix timestamp of when the blackhole expires as <em>float</em> or <em>int</em>.</p></li>
|
||||
<li><p><strong>reason</strong> – Optional reason for the blackhole as <em>str</em>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><em>True</em> if successful, otherwise <em>False</em>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="RNS.Transport.unblackhole_identity">
|
||||
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unblackhole_identity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identity_hash</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Transport.unblackhole_identity" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Lifts blackhole for an identity.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>identity_hash</strong> – The identity hash to blackhole as <em>bytes</em>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><em>True</em> if successful, otherwise <em>False</em>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
@@ -2472,6 +2504,8 @@ will announce it.</p>
|
||||
<li><a class="reference internal" href="#RNS.Transport.next_hop_interface"><code class="docutils literal notranslate"><span class="pre">next_hop_interface()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#RNS.Transport.await_path"><code class="docutils literal notranslate"><span class="pre">await_path()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#RNS.Transport.request_path"><code class="docutils literal notranslate"><span class="pre">request_path()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#RNS.Transport.blackhole_identity"><code class="docutils literal notranslate"><span class="pre">blackhole_identity()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#RNS.Transport.unblackhole_identity"><code class="docutils literal notranslate"><span class="pre">unblackhole_identity()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -399,8 +399,8 @@
|
||||
<p>This is not about “dropping out” of society. It is about building a substrate on which an actual <em>Society</em> can function.</p>
|
||||
<p><strong>Consider:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>The Old Way:</strong> “My connection is slow. I should call my ISP and complain.”</p></li>
|
||||
<li><p><strong>The Zen Way:</strong> “The path is noisy. I will adjust the antenna or find a better route.”</p></li>
|
||||
<li><p><strong>The Old Way:</strong> <em>“My connection is slow. I should call my ISP and complain.”</em></p></li>
|
||||
<li><p><strong>The Zen Way:</strong> <em>“The path is noisy. I will adjust the antenna or find a better route.”</em></p></li>
|
||||
</ul>
|
||||
<p>By taking ownership of the infrastructure, you take ownership of your voice. You stop shouting into someone else’s megaphone and start building your own. The network is no longer something that happens to you; it is something you make happen.</p>
|
||||
</section>
|
||||
|
||||
@@ -717,9 +717,6 @@ If verification succeeds, the retrieved artifact files, along with the release m
|
||||
|
||||
#### IMPORTANT
|
||||
Keeping the retrieved release manifest is a **very** good idea! It allows you to easily obtain future releases and updates to the software directly, while verifying they came from the same publisher.
|
||||
```rawmu
|
||||
>>>
|
||||
```
|
||||
|
||||
**Obtaining & Updating Releases Using RSM Manifests**
|
||||
|
||||
|
||||
@@ -1295,4 +1295,24 @@ will announce it.
|
||||
|
||||
* **Parameters:**
|
||||
* **destination_hash** – A destination hash as *bytes*.
|
||||
* **on_interface** – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.
|
||||
* **on_interface** – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.
|
||||
|
||||
#### `static blackhole_identity(identity_hash, until=None, reason=None)`
|
||||
|
||||
Blackholes an identity.
|
||||
|
||||
* **Parameters:**
|
||||
* **identity_hash** – The identity hash to blackhole as *bytes*.
|
||||
* **until** – Optional unix timestamp of when the blackhole expires as *float* or *int*.
|
||||
* **reason** – Optional reason for the blackhole as *str*.
|
||||
* **Returns:**
|
||||
*True* if successful, otherwise *False*.
|
||||
|
||||
#### `static unblackhole_identity(identity_hash)`
|
||||
|
||||
Lifts blackhole for an identity.
|
||||
|
||||
* **Parameters:**
|
||||
**identity_hash** – The identity hash to blackhole as *bytes*.
|
||||
* **Returns:**
|
||||
*True* if successful, otherwise *False*.
|
||||
@@ -189,8 +189,8 @@ This is not about “dropping out” of society. It is about building a substrat
|
||||
|
||||
**Consider:**
|
||||
|
||||
- **The Old Way:** “My connection is slow. I should call my ISP and complain.”
|
||||
- **The Zen Way:** “The path is noisy. I will adjust the antenna or find a better route.”
|
||||
- **The Old Way:** *“My connection is slow. I should call my ISP and complain.”*
|
||||
- **The Zen Way:** *“The path is noisy. I will adjust the antenna or find a better route.”*
|
||||
|
||||
By taking ownership of the infrastructure, you take ownership of your voice. You stop shouting into someone else’s megaphone and start building your own. The network is no longer something that happens to you; it is something you make happen.
|
||||
|
||||
|
||||
+2
-2
@@ -210,8 +210,8 @@ This is not about "dropping out" of society. It is about building a substrate on
|
||||
|
||||
**Consider:**
|
||||
|
||||
- **The Old Way:** "My connection is slow. I should call my ISP and complain."
|
||||
- **The Zen Way:** "The path is noisy. I will adjust the antenna or find a better route."
|
||||
- **The Old Way:** *"My connection is slow. I should call my ISP and complain."*
|
||||
- **The Zen Way:** *"The path is noisy. I will adjust the antenna or find a better route."*
|
||||
|
||||
By taking ownership of the infrastructure, you take ownership of your voice. You stop shouting into someone else's megaphone and start building your own. The network is no longer something that happens to you; it is something you make happen.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user