update docs for unstable
This commit is contained in:
=
parent
5a795b2b37
commit
4b6d4c9126
|
|
@ -260,7 +260,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -801,7 +801,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:13 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -874,7 +874,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -391,7 +391,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1703,7 +1703,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:10 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -398,7 +398,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1450,7 +1450,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:55 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3040,7 +3040,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:54 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:08 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -940,7 +940,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:54 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -275,7 +275,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1195,7 +1195,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:54 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:08 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1029,7 +1029,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:54 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:08 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -908,7 +908,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:54 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -381,7 +381,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -450,7 +450,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -340,7 +340,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:10 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -2551,7 +2551,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -396,7 +396,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:55 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -481,7 +481,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:55 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -689,7 +689,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:10 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -539,7 +539,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -233,18 +233,22 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readMsg
|
||||
<li><a class="reference" href="#readMsg%2CConnection"
|
||||
title="readMsg(conn: Connection): Future[Msg]">readMsg(conn: Connection): Future[Msg]</a></li>
|
||||
title="readMsg(conn: Connection): InternalRaisesFuture[Msg,
|
||||
(CancelledError, LPStreamError, MuxerError)]">readMsg(conn: Connection): InternalRaisesFuture[Msg,
|
||||
(CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">writeMsg
|
||||
<li><a class="reference" href="#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cseq%5Bbyte%5D"
|
||||
title="writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): Future[void]">writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): Future[void]</a></li>
|
||||
data: seq[byte] = @[]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference" href="#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cstring"
|
||||
title="writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): Future[
|
||||
void]">writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): Future[
|
||||
void]</a></li>
|
||||
title="writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]">writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -343,41 +347,45 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="readMsg,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readMsg%2CConnection"><span class="Identifier">readMsg</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="coder.html#Msg"><span class="Identifier">Msg</span></a><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readMsg%2CConnection"><span class="Identifier">readMsg</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><a href="coder.html#Msg"><span class="Identifier">Msg</span></a><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">,</span> <a href="../muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L45"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L47"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="writeMsg,Connection,uint64,MessageType,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cseq%5Bbyte%5D"><span class="Identifier">writeMsg</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">id</span><span class="Other">:</span> <span class="Identifier">uint64</span><span class="Other">;</span> <span class="Identifier">msgType</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L58"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L66"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="writeMsg,Connection,uint64,MessageType,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cstring"><span class="Identifier">writeMsg</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">id</span><span class="Other">:</span> <span class="Identifier">uint64</span><span class="Other">;</span> <span class="Identifier">msgType</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cstring"><span class="Identifier">writeMsg</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">id</span><span class="Other">:</span> <span class="Identifier">uint64</span><span class="Other">;</span> <span class="Identifier">msgType</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">void</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L87"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/coder.nim#L98"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/coder.nim#L98" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -391,7 +399,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -246,7 +246,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">close
|
||||
<li><a class="reference" href="#close.e%2CMplex"
|
||||
title="close(m: Mplex): Future[void]">close(m: Mplex): Future[void]</a></li>
|
||||
title="close(m: Mplex): InternalRaisesFuture[void, void]">close(m: Mplex): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getStreams
|
||||
|
|
@ -256,7 +256,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">newStream
|
||||
<li><a class="reference" href="#newStream.e%2CMplex%2Cstring%2Cbool"
|
||||
title="newStream(m: Mplex; name: string = ""; lazy: bool = false): Future[Connection]">newStream(m: Mplex; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
title="newStream(m: Mplex; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]">newStream(m: Mplex; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -358,9 +360,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L201"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L199"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L201" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L199" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -382,16 +384,15 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="close.e,Mplex" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CMplex"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="lpchannel.html#Mplex"><span class="Identifier">Mplex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CMplex"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="lpchannel.html#Mplex"><span class="Identifier">Mplex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L222"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L224"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L222" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L224" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -401,23 +402,24 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L250"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L252"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L252" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newStream.e,Mplex,string,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CMplex%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="lpchannel.html#Mplex"><span class="Identifier">Mplex</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CMplex%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="lpchannel.html#Mplex"><span class="Identifier">Mplex</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">,</span> <a href="../muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a><span class="Other">)</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L214"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/mplex/mplex.nim#L215"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L214" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/mplex.nim#L215" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -453,7 +455,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -208,20 +208,20 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<li><a class="reference" href="#Muxer"
|
||||
title="Muxer = ref object of RootObj
|
||||
streamHandler*: StreamHandler
|
||||
handler*: Future[void]
|
||||
handler*: Future[void].Raising([])
|
||||
connection*: Connection">Muxer</a></li>
|
||||
<li><a class="reference" href="#MuxerConstructor"
|
||||
title="MuxerConstructor = proc (conn: Connection): Muxer {.gcsafe, closure, raises: [].}">MuxerConstructor</a></li>
|
||||
<li><a class="reference" href="#MuxerError"
|
||||
title="MuxerError = object of LPError">MuxerError</a></li>
|
||||
<li><a class="reference" href="#MuxerHandler"
|
||||
title="MuxerHandler = proc (muxer: Muxer): Future[void] {.gcsafe, raises: [].}">MuxerHandler</a></li>
|
||||
title="MuxerHandler = proc (muxer: Muxer): Future[void] {.async: (raises: []).}">MuxerHandler</a></li>
|
||||
<li><a class="reference" href="#MuxerProvider"
|
||||
title="MuxerProvider = object
|
||||
newMuxer*: MuxerConstructor
|
||||
codec*: string">MuxerProvider</a></li>
|
||||
<li><a class="reference" href="#StreamHandler"
|
||||
title="StreamHandler = proc (conn: Connection): Future[void] {.gcsafe, raises: [].}">StreamHandler</a></li>
|
||||
title="StreamHandler = proc (conn: Connection): Future[void] {.async: (raises: []).}">StreamHandler</a></li>
|
||||
<li><a class="reference" href="#TooManyChannels"
|
||||
title="TooManyChannels = object of MuxerError">TooManyChannels</a></li>
|
||||
|
||||
|
|
@ -256,7 +256,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">close
|
||||
<li><a class="reference" href="#close.e%2CMuxer"
|
||||
title="close(m: Muxer): Future[void]">close(m: Muxer): Future[void]</a></li>
|
||||
title="close(m: Muxer): InternalRaisesFuture[void, void]">close(m: Muxer): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getStreams
|
||||
|
|
@ -266,12 +266,14 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">handle
|
||||
<li><a class="reference" href="#handle.e%2CMuxer"
|
||||
title="handle(m: Muxer): Future[void]">handle(m: Muxer): Future[void]</a></li>
|
||||
title="handle(m: Muxer): InternalRaisesFuture[void, void]">handle(m: Muxer): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newStream
|
||||
<li><a class="reference" href="#newStream.e%2CMuxer%2Cstring%2Cbool"
|
||||
title="newStream(m: Muxer; name: string = ""; lazy: bool = false): Future[Connection]">newStream(m: Muxer; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
title="newStream(m: Muxer; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]">newStream(m: Muxer; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -312,7 +314,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div id="Muxer" class="tohide">
|
||||
<dt><pre><a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">RootObj</span>
|
||||
<span class="Identifier">streamHandler</span><span class="Operator">*</span><span class="Other">:</span> <a href="muxer.html#StreamHandler"><span class="Identifier">StreamHandler</span></a>
|
||||
<span class="Identifier">handler</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span>
|
||||
<span class="Identifier">handler</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">.</span><span class="Identifier">Raising</span><span class="Other">(</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span>
|
||||
<span class="Identifier">connection</span><span class="Operator">*</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
|
@ -350,7 +352,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="MuxerHandler" class="tohide">
|
||||
<dt><pre><a href="muxer.html#MuxerHandler"><span class="Identifier">MuxerHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">muxer</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><a href="muxer.html#MuxerHandler"><span class="Identifier">MuxerHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">muxer</span><span class="Other">:</span> <span class="Identifier">Muxer</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">async</span><span class="Other">:</span> <span class="Other">(</span><span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">)</span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
|
@ -370,14 +372,14 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L38"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L39"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="StreamHandler" class="tohide">
|
||||
<dt><pre><a href="muxer.html#StreamHandler"><span class="Identifier">StreamHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><a href="muxer.html#StreamHandler"><span class="Identifier">StreamHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <span class="Identifier">Connection</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">async</span><span class="Other">:</span> <span class="Other">(</span><span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">)</span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
|
@ -429,9 +431,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L55"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L64"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -441,9 +443,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L42"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L43"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -453,16 +455,16 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="close.e,Muxer" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CMuxer"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CMuxer"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L50"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L58"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L50" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -472,37 +474,37 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L63"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L71"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handle.e,Muxer" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CMuxer"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CMuxer"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L53"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L62"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newStream.e,Muxer,string,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CMuxer%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CMuxer%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">,</span> <a href="muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L49"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L54"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -517,9 +519,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L45"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/muxer.nim#L47"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/muxer.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -533,7 +535,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -231,7 +231,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
recvQueue: seq[byte]
|
||||
isReset: bool
|
||||
remoteReset: bool
|
||||
closedRemotely: Future[void]
|
||||
closedRemotely: Future[void].Raising([])
|
||||
closedLocally: bool
|
||||
receivedData: AsyncEvent
|
||||
returnedEof: bool">YamuxChannel</a></li>
|
||||
|
|
@ -277,12 +277,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">close
|
||||
<li><a class="reference" href="#close.e%2CYamux"
|
||||
title="close(m: Yamux): Future[void]">close(m: Yamux): Future[void]</a></li>
|
||||
title="close(m: Yamux): InternalRaisesFuture[void, void]">close(m: Yamux): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CYamuxChannel"
|
||||
title="closeImpl(channel: YamuxChannel): Future[void]">closeImpl(channel: YamuxChannel): Future[void]</a></li>
|
||||
title="closeImpl(channel: YamuxChannel): InternalRaisesFuture[void, void]">closeImpl(channel: YamuxChannel): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getStreams
|
||||
|
|
@ -297,22 +297,28 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">handle
|
||||
<li><a class="reference" href="#handle.e%2CYamux"
|
||||
title="handle(m: Yamux): Future[void]">handle(m: Yamux): Future[void]</a></li>
|
||||
title="handle(m: Yamux): InternalRaisesFuture[void, void]">handle(m: Yamux): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newStream
|
||||
<li><a class="reference" href="#newStream.e%2CYamux%2Cstring%2Cbool"
|
||||
title="newStream(m: Yamux; name: string = ""; lazy: bool = false): Future[Connection]">newStream(m: Yamux; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
title="newStream(m: Yamux; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]">newStream(m: Yamux; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CYamuxChannel%2Cpointer%2Cint"
|
||||
title="readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): Future[int]">readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]">readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CYamuxChannel%2Cseq%5Bbyte%5D"
|
||||
title="write(channel: YamuxChannel; msg: seq[byte]): Future[void]">write(channel: YamuxChannel; msg: seq[byte]): Future[void]</a></li>
|
||||
title="write(channel: YamuxChannel; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(channel: YamuxChannel; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -361,9 +367,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L394"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L421"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L394" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L421" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -382,7 +388,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<span class="Identifier">recvQueue</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span>
|
||||
<span class="Identifier">isReset</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">remoteReset</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">closedRemotely</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span>
|
||||
<span class="Identifier">closedRemotely</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">.</span><span class="Identifier">Raising</span><span class="Other">(</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span>
|
||||
<span class="Identifier">closedLocally</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">receivedData</span><span class="Other">:</span> <span class="Identifier">AsyncEvent</span>
|
||||
<span class="Identifier">returnedEof</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
|
|
@ -391,9 +397,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L142"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L150"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L150" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -403,9 +409,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L37"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L40"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -453,9 +459,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L587"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L633"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L587" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L633" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -466,9 +472,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L296"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L310"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L296" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L310" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -478,29 +484,29 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="close.e,Yamux" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CYamux"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L458"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L458" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,YamuxChannel" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CYamuxChannel"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CYamux"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L197"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L493"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L197" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L493" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,YamuxChannel" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CYamuxChannel"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L205"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -510,9 +516,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L571"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L616"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L571" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L616" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -522,64 +528,66 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L391"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L418"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L391" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L418" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handle.e,Yamux" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CYamux"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CYamux"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L484"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L516"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L484" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L516" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newStream.e,Yamux,string,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CYamux%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L577"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L577" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,YamuxChannel,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CYamuxChannel%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CYamux%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">,</span> <a href="../muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a><span class="Other">)</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L623"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L623" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,YamuxChannel,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CYamuxChannel%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Read from a yamux channel
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L255"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L265"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L255" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L265" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,YamuxChannel,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CYamuxChannel%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CYamuxChannel%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Write to yamux channel
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L361"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/muxers/yamux/yamux.nim#L385"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L361" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L385" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -598,7 +606,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -375,7 +375,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -360,7 +360,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -806,7 +806,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:10 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -484,7 +484,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -931,7 +931,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:53 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:07 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -508,7 +508,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -302,7 +302,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -468,7 +468,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:13 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -722,7 +722,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CRelayConnection"
|
||||
title="closeImpl(self: RelayConnection): Future[void]">closeImpl(self: RelayConnection): Future[void]</a></li>
|
||||
title="closeImpl(self: RelayConnection): InternalRaisesFuture[void, void]">closeImpl(self: RelayConnection): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getWrapped
|
||||
|
|
@ -242,12 +242,16 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CRelayConnection%2Cpointer%2Cint"
|
||||
title="readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): Future[int]">readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]">readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CRelayConnection%2Cseq%5Bbyte%5D"
|
||||
title="write(self: RelayConnection; msg: seq[byte]): Future[void]">write(self: RelayConnection; msg: seq[byte]): Future[void]</a></li>
|
||||
title="write(self: RelayConnection; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(self: RelayConnection; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -303,9 +307,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L44"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L48"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -315,20 +319,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="closeImpl.e,RelayConnection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CRelayConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L38"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getWrapped.e,RelayConnection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#getWrapped.e%2CRelayConnection"><span class="Identifier">getWrapped</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">)</span><span class="Other">:</span> <a href="../../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CRelayConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
|
@ -339,31 +332,44 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,RelayConnection,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CRelayConnection%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<div id="getWrapped.e,RelayConnection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#getWrapped.e%2CRelayConnection"><span class="Identifier">getWrapped</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">)</span><span class="Other">:</span> <a href="../../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L26"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L46"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L26" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,RelayConnection,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CRelayConnection%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L27"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,RelayConnection,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CRelayConnection%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CRelayConnection%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L30"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/rconn.nim#L34"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L30" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/rconn.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -377,7 +383,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -567,7 +567,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -414,7 +414,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:13 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -368,7 +368,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -636,7 +636,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -414,7 +414,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -467,7 +467,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -239,7 +239,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -255,7 +255,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -468,7 +468,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -568,7 +568,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -496,7 +496,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -447,7 +447,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -780,7 +780,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -403,7 +403,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -370,7 +370,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1158,7 +1158,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -731,7 +731,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -342,7 +342,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -645,7 +645,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -596,7 +596,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -422,7 +422,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -530,7 +530,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -261,7 +261,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CNoiseConnection"
|
||||
title="closeImpl(s: NoiseConnection): Future[void]">closeImpl(s: NoiseConnection): Future[void]</a></li>
|
||||
title="closeImpl(s: NoiseConnection): InternalRaisesFuture[void, void]">closeImpl(s: NoiseConnection): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">handshake
|
||||
|
|
@ -278,12 +278,16 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readMessage
|
||||
<li><a class="reference" href="#readMessage.e%2CNoiseConnection"
|
||||
title="readMessage(sconn: NoiseConnection): Future[seq[byte]]">readMessage(sconn: NoiseConnection): Future[seq[byte]]</a></li>
|
||||
title="readMessage(sconn: NoiseConnection): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]">readMessage(sconn: NoiseConnection): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CNoiseConnection%2Cseq%5Bbyte%5D"
|
||||
title="write(sconn: NoiseConnection; message: seq[byte]): Future[void]">write(sconn: NoiseConnection; message: seq[byte]): Future[void]</a></li>
|
||||
title="write(sconn: NoiseConnection; message: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(sconn: NoiseConnection; message: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -445,9 +449,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L599"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L607"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L599" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L607" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -469,15 +473,16 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="closeImpl.e,NoiseConnection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CNoiseConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CNoiseConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L589"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L597"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L589" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L597" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -489,9 +494,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L504"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L512"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L504" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L512" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -501,36 +506,38 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L595"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L603"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L595" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L603" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readMessage.e,NoiseConnection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readMessage.e%2CNoiseConnection"><span class="Identifier">readMessage</span></a><span class="Other">(</span><span class="Identifier">sconn</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readMessage.e%2CNoiseConnection"><span class="Identifier">readMessage</span></a><span class="Other">(</span><span class="Identifier">sconn</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L429"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L433"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L429" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L433" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,NoiseConnection,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CNoiseConnection%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">sconn</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CNoiseConnection%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">sconn</span><span class="Other">:</span> <a href="noise.html#NoiseConnection"><span class="Identifier">NoiseConnection</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">void</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L461"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/noise.nim#L468"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L461" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/noise.nim#L468" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -561,7 +568,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -247,7 +247,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CSecureConn"
|
||||
title="closeImpl(s: SecureConn): Future[void]">closeImpl(s: SecureConn): Future[void]</a></li>
|
||||
title="closeImpl(s: SecureConn): InternalRaisesFuture[void, void]">closeImpl(s: SecureConn): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getWrapped
|
||||
|
|
@ -274,12 +274,16 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readMessage
|
||||
<li><a class="reference" href="#readMessage.e%2CSecureConn"
|
||||
title="readMessage(c: SecureConn): Future[seq[byte]]">readMessage(c: SecureConn): Future[seq[byte]]</a></li>
|
||||
title="readMessage(c: SecureConn): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]">readMessage(c: SecureConn): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CSecureConn%2Cpointer%2Cint"
|
||||
title="readOnce(s: SecureConn; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: SecureConn; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(s: SecureConn; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]">readOnce(s: SecureConn; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">secure
|
||||
|
|
@ -410,15 +414,16 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="closeImpl.e,SecureConn" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CSecureConn"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CSecureConn"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L66"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L67"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -428,9 +433,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L76"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L80"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L80" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -443,9 +448,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L81"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L85"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -455,9 +460,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L131"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L135"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -468,37 +473,38 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L60"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L61"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readMessage.e,SecureConn" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readMessage.e%2CSecureConn"><span class="Identifier">readMessage</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readMessage.e%2CSecureConn"><span class="Identifier">readMessage</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L73"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L76"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,SecureConn,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CSecureConn%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CSecureConn%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#SecureConn"><span class="Identifier">SecureConn</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L160"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L165"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L160" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L165" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -509,9 +515,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L151"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/secure/secure.nim#L155"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L151" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -547,7 +553,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -422,7 +422,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -503,7 +503,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -255,7 +255,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CBufferStream"
|
||||
title="closeImpl(s: BufferStream): Future[void]">closeImpl(s: BufferStream): Future[void]</a></li>
|
||||
title="closeImpl(s: BufferStream): InternalRaisesFuture[void, void]">closeImpl(s: BufferStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">initStream
|
||||
|
|
@ -265,17 +265,23 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">pushData
|
||||
<li><a class="reference" href="#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D"
|
||||
title="pushData(s: BufferStream; data: seq[byte]): Future[void]">pushData(s: BufferStream; data: seq[byte]): Future[void]</a></li>
|
||||
title="pushData(s: BufferStream; data: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">pushData(s: BufferStream; data: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">pushEof
|
||||
<li><a class="reference" href="#pushEof.e%2CBufferStream"
|
||||
title="pushEof(s: BufferStream): Future[void]">pushEof(s: BufferStream): Future[void]</a></li>
|
||||
title="pushEof(s: BufferStream): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">pushEof(s: BufferStream): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CBufferStream%2Cpointer%2Cint"
|
||||
title="readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(s: BufferStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]">readOnce(s: BufferStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -408,21 +414,23 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L108"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L112"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L112" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,BufferStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CBufferStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CBufferStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
close the stream and clear the buffer
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L176"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L175"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L176" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L175" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -439,45 +447,48 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="pushData.e,BufferStream,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D"><span class="Identifier">pushData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D"><span class="Identifier">pushData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Write bytes to internal read buffer, use this to fill up the buffer with data.</p>
|
||||
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">pushTo</span></span></tt> will block if the queue is full, thus maintaining backpressure. </p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L65"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L67"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="pushEof.e,BufferStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#pushEof.e%2CBufferStream"><span class="Identifier">pushEof</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#pushEof.e%2CBufferStream"><span class="Identifier">pushEof</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L90"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L94"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,BufferStream,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CBufferStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CBufferStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L114"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/bufferstream.nim#L119"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L114" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L119" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -513,7 +524,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -254,7 +254,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CChronosStream"
|
||||
title="closeImpl(s: ChronosStream): Future[void]">closeImpl(s: ChronosStream): Future[void]</a></li>
|
||||
title="closeImpl(s: ChronosStream): InternalRaisesFuture[void, void]">closeImpl(s: ChronosStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getWrapped
|
||||
|
|
@ -269,12 +269,16 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CChronosStream%2Cpointer%2Cint"
|
||||
title="readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]">readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CChronosStream%2Cseq%5Bbyte%5D"
|
||||
title="write(s: ChronosStream; msg: seq[byte]): Future[void]">write(s: ChronosStream; msg: seq[byte]): Future[void]</a></li>
|
||||
title="write(s: ChronosStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(s: ChronosStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -359,9 +363,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L59"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L63"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -371,9 +375,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L40"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L44"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -388,9 +392,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L145"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L161"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L161" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -400,22 +404,23 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L142"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L158"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,ChronosStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CChronosStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CChronosStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L148"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L165"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L148" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L165" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -425,9 +430,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L168"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L179"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L168" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L179" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -437,36 +442,38 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L49"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L53"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,ChronosStream,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CChronosStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CChronosStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L97"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L106"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L97" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,ChronosStream,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CChronosStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CChronosStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="chronosstream.html#ChronosStream"><span class="Identifier">ChronosStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L127"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L142"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L127" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -481,9 +488,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L47"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/chronosstream.nim#L51"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/chronosstream.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -497,7 +504,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -209,7 +209,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
title="Connection = ref object of LPStream
|
||||
activity*: bool
|
||||
timeout*: Duration
|
||||
timerTaskFut: Future[void]
|
||||
timerTaskFut: Future[void].Raising([])
|
||||
timeoutHandler*: TimeoutHandler
|
||||
peerId*: PeerId
|
||||
observedAddr*: Opt[MultiAddress]
|
||||
|
|
@ -218,7 +218,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
when defined(libp2p_agents_metrics):
|
||||
shortAgent*: string">Connection</a></li>
|
||||
<li><a class="reference" href="#TimeoutHandler"
|
||||
title="TimeoutHandler = proc (): Future[void] {.gcsafe, raises: [].}">TimeoutHandler</a></li>
|
||||
title="TimeoutHandler = proc (): Future[void] {.async: (raises: []).}">TimeoutHandler</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -264,7 +264,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CConnection"
|
||||
title="closeImpl(s: Connection): Future[void]">closeImpl(s: Connection): Future[void]</a></li>
|
||||
title="closeImpl(s: Connection): InternalRaisesFuture[void, void]">closeImpl(s: Connection): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getWrapped
|
||||
|
|
@ -322,7 +322,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<dt><pre><a href="connection.html#Connection"><span class="Identifier">Connection</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a>
|
||||
<span class="Identifier">activity</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">timeout</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Duration</span>
|
||||
<span class="Identifier">timerTaskFut</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span>
|
||||
<span class="Identifier">timerTaskFut</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">.</span><span class="Identifier">Raising</span><span class="Other">(</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span>
|
||||
<span class="Identifier">timeoutHandler</span><span class="Operator">*</span><span class="Other">:</span> <a href="connection.html#TimeoutHandler"><span class="Identifier">TimeoutHandler</span></a>
|
||||
<span class="Identifier">peerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
|
||||
<span class="Identifier">observedAddr</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span>
|
||||
|
|
@ -343,7 +343,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="TimeoutHandler" class="tohide">
|
||||
<dt><pre><a href="connection.html#TimeoutHandler"><span class="Identifier">TimeoutHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><a href="connection.html#TimeoutHandler"><span class="Identifier">TimeoutHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">async</span><span class="Other">:</span> <span class="Other">(</span><span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">)</span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
|
@ -394,9 +394,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L84"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L89"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L89" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -409,9 +409,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L141"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L137"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L141" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L137" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -433,14 +433,16 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="closeImpl.e,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CConnection"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L72"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L73"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -450,9 +452,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L131"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/connection.nim#L127"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/connection.nim#L127" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -500,7 +502,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -259,7 +259,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">closeWithEOF
|
||||
<li><a class="reference" href="#closeWithEOF%2CLPStream"
|
||||
title="closeWithEOF(s: LPStream): Future[void]">closeWithEOF(s: LPStream): Future[void]</a></li>
|
||||
title="closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]">closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">join
|
||||
|
|
@ -304,22 +304,30 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readExactly
|
||||
<li><a class="reference" href="#readExactly%2CLPStream%2Cpointer%2Cint"
|
||||
title="readExactly(s: LPStream; pbytes: pointer; nbytes: int): Future[void]">readExactly(s: LPStream; pbytes: pointer; nbytes: int): Future[void]</a></li>
|
||||
title="readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]">readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readLine
|
||||
<li><a class="reference" href="#readLine%2CLPStream%2Cint%2Cstring"
|
||||
title="readLine(s: LPStream; limit = 0; sep = "\r\n"): Future[string]">readLine(s: LPStream; limit = 0; sep = "\r\n"): Future[string]</a></li>
|
||||
title="readLine(s: LPStream; limit = 0; sep = "\r\n"): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError)]">readLine(s: LPStream; limit = 0; sep = "\r\n"): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readLp
|
||||
<li><a class="reference" href="#readLp%2CLPStream%2Cint"
|
||||
title="readLp(s: LPStream; maxSize: int): Future[seq[byte]]">readLp(s: LPStream; maxSize: int): Future[seq[byte]]</a></li>
|
||||
title="readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]">readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">readVarint
|
||||
<li><a class="reference" href="#readVarint%2CLPStream"
|
||||
title="readVarint(conn: LPStream): Future[uint64]">readVarint(conn: LPStream): Future[uint64]</a></li>
|
||||
title="readVarint(conn: LPStream): InternalRaisesFuture[uint64,
|
||||
(CancelledError, LPStreamError)]">readVarint(conn: LPStream): InternalRaisesFuture[uint64,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">shortLog
|
||||
|
|
@ -329,14 +337,20 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write%2CLPStream%2Cstring"
|
||||
title="write(s: LPStream; msg: string): Future[void]">write(s: LPStream; msg: string): Future[void]</a></li>
|
||||
title="write(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">writeLp
|
||||
<li><a class="reference" href="#writeLp%2CLPStream%2CopenArray%5Bbyte%5D"
|
||||
title="writeLp(s: LPStream; msg: openArray[byte]): Future[void]">writeLp(s: LPStream; msg: openArray[byte]): Future[void]</a></li>
|
||||
title="writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference" href="#writeLp%2CLPStream%2Cstring"
|
||||
title="writeLp(s: LPStream; msg: string): Future[void]">writeLp(s: LPStream; msg: string): Future[void]</a></li>
|
||||
title="writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -352,7 +366,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">close
|
||||
<li><a class="reference" href="#close.e%2CLPStream"
|
||||
title="close(s: LPStream): Future[void]">close(s: LPStream): Future[void]</a></li>
|
||||
title="close(s: LPStream): InternalRaisesFuture[void, void]">close(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">closed
|
||||
|
|
@ -362,7 +376,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CLPStream"
|
||||
title="closeImpl(s: LPStream): Future[void]">closeImpl(s: LPStream): Future[void]</a></li>
|
||||
title="closeImpl(s: LPStream): InternalRaisesFuture[void, void]">closeImpl(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">initStream
|
||||
|
|
@ -372,12 +386,16 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CLPStream%2Cpointer%2Cint"
|
||||
title="readOnce(s: LPStream; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: LPStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]">readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CLPStream%2Cseq%5Bbyte%5D"
|
||||
title="write(s: LPStream; msg: seq[byte]): Future[void]">write(s: LPStream; msg: seq[byte]): Future[void]</a></li>
|
||||
title="write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -624,9 +642,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="closeWithEOF,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#closeWithEOF%2CLPStream"><span class="Identifier">closeWithEOF</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#closeWithEOF%2CLPStream"><span class="Identifier">closeWithEOF</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Close the stream and wait for EOF - use this with half-closed streams where an EOF is expected to arrive from the other end.</p>
|
||||
|
|
@ -634,9 +652,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<p>In particular, it must not be used when there is another concurrent read ongoing (which may be the case during cancellations)! </p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L278"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L314"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L314" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -648,9 +666,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L118"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L119"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L119" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -745,58 +763,62 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="readExactly,LPStream,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readExactly%2CLPStream%2Cpointer%2Cint"><span class="Identifier">readExactly</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Waits for <tt class="docutils literal"><span class="pre"><span class="Identifier">nbytes</span></span></tt> to be available, then read them and return them
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L141"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L141" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readLine,LPStream,int,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CLPStream%2Cint%2Cstring"><span class="Identifier">readLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">limit</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">sep</span> <span class="Other">=</span> <span class="StringLit">"\r\n"</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Reads up to <tt class="docutils literal"><span class="pre"><span class="Identifier">limit</span></span></tt> bytes are read, or a <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> is found
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L178"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L178" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readLp,LPStream,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readLp%2CLPStream%2Cint"><span class="Identifier">readLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">maxSize</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
read length prefixed msg, with the length encoded as a varint
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L222"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L222" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readVarint,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readVarint%2CLPStream"><span class="Identifier">readVarint</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">uint64</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readExactly%2CLPStream%2Cpointer%2Cint"><span class="Identifier">readExactly</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">void</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Waits for <tt class="docutils literal"><span class="pre"><span class="Identifier">nbytes</span></span></tt> to be available, then read them and return them
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L144"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L144" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readLine,LPStream,int,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CLPStream%2Cint%2Cstring"><span class="Identifier">readLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">limit</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">sep</span> <span class="Other">=</span> <span class="StringLit">"\r\n"</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">string</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Reads up to <tt class="docutils literal"><span class="pre"><span class="Identifier">limit</span></span></tt> bytes are read, or a <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> is found
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L182"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L182" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readLp,LPStream,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readLp%2CLPStream%2Cint"><span class="Identifier">readLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">maxSize</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
read length prefixed msg, with the length encoded as a varint
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L231"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L231" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readVarint,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readVarint%2CLPStream"><span class="Identifier">readVarint</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">uint64</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L204"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L210"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L204" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L210" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -813,41 +835,47 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="write,LPStream,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#write%2CLPStream%2Cstring"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#write%2CLPStream%2Cstring"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L253"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L278"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L253" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="writeLp,LPStream,openArray[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeLp%2CLPStream%2CopenArray%5Bbyte%5D"><span class="Identifier">writeLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeLp%2CLPStream%2CopenArray%5Bbyte%5D"><span class="Identifier">writeLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Write <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> with a varint-encoded length prefix
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L242"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L259"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L242" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L259" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="writeLp,LPStream,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeLp%2CLPStream%2Cstring"><span class="Identifier">writeLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#writeLp%2CLPStream%2Cstring"><span class="Identifier">writeLp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L250"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L271"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L271" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -862,23 +890,23 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L125"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L126"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L125" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="close.e,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CLPStream"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CLPStream"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
close the stream - this may block, but will not raise exceptions
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L264"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L297"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L297" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -888,23 +916,23 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L122"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L123"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L122" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CLPStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CLPStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Implementation of close - called only once
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L256"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L284"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L256" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L284" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -914,36 +942,38 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L105"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L106"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L105" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,LPStream,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CLPStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
|
||||
<span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CLPStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Reads whatever is available in the stream, up to <tt class="docutils literal"><span class="pre"><span class="Identifier">nbytes</span></span></tt>. Will block if nothing is available
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L132"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L133"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L132" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L133" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,LPStream,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CLPStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CLPStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpstream.html#LPStream"><span class="Identifier">LPStream</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L238"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L251"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L238" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L251" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -958,9 +988,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L103"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/stream/lpstream.nim#L104"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L103" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L104" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -979,7 +1009,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -442,7 +442,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -750,7 +750,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -266,7 +266,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:56 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:10 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -476,7 +476,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -488,7 +488,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -263,7 +263,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">closeImpl
|
||||
<li><a class="reference" href="#closeImpl.e%2CWsStream"
|
||||
title="closeImpl(s: WsStream): Future[void]">closeImpl(s: WsStream): Future[void]</a></li>
|
||||
title="closeImpl(s: WsStream): InternalRaisesFuture[void, void]">closeImpl(s: WsStream): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">dial
|
||||
|
|
@ -290,7 +290,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">readOnce
|
||||
<li><a class="reference" href="#readOnce.e%2CWsStream%2Cpointer%2Cint"
|
||||
title="readOnce(s: WsStream; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: WsStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
title="readOnce(s: WsStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]">readOnce(s: WsStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">start
|
||||
|
|
@ -305,7 +307,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
|||
</ul>
|
||||
<ul class="simple nested-toc-section">write
|
||||
<li><a class="reference" href="#write.e%2CWsStream%2Cseq%5Bbyte%5D"
|
||||
title="write(s: WsStream; msg: seq[byte]): Future[void]">write(s: WsStream; msg: seq[byte]): Future[void]</a></li>
|
||||
title="write(s: WsStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">write(s: WsStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
@ -356,9 +360,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L102"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L108"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L102" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -390,9 +394,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
Creates a clear-text WebSocket transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L350"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L356"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L350" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L356" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -406,9 +410,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
Creates a secure WebSocket transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L328"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L334"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L328" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L334" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -418,9 +422,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L117"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L123"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L117" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -436,22 +440,23 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
accept a new WS connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L244"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L250"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L244" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="closeImpl.e,WsStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CWsStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CWsStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">void</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L95"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L98"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L95" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L98" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -464,9 +469,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
dial a peer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L302"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L308"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L302" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L308" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -476,9 +481,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L99"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L105"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L99" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L105" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -489,9 +494,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L323"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L329"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L323" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L329" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -508,16 +513,16 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
</dd>
|
||||
</div>
|
||||
<div id="readOnce.e,WsStream,pointer,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CWsStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
|
||||
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CWsStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span>
|
||||
<span class="Identifier">int</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L81"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L83"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L83" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -529,9 +534,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
listen on the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L122"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L128"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L122" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L128" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -542,22 +547,24 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
|
||||
stop the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L180"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L186"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L180" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L186" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="write.e,WsStream,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CWsStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
||||
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CWsStream%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">WsStream</span><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
|
||||
<span class="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</span> <a href="../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a><span class="Other">)</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L91"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/transports/wstransport.nim#L94"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L91" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/wstransport.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
|
@ -576,7 +583,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:59 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -350,7 +350,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:13 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -370,7 +370,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -444,7 +444,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:53 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:07 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -271,7 +271,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -245,7 +245,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -512,7 +512,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:58 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -362,7 +362,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:11 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -725,7 +725,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:53 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:07 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -636,7 +636,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:55 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:09 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -604,7 +604,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:39:57 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:12 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -661,13 +661,13 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: close(c: ConnManager): Future[void]" href="libp2p/connmanager.html#close%2CConnManager">connmanager: close(c: ConnManager): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="mplex: close(m: Mplex): Future[void]" href="libp2p/muxers/mplex/mplex.html#close.e%2CMplex">mplex: close(m: Mplex): Future[void]</a></li>
|
||||
data-doc-search-tag="mplex: close(m: Mplex): InternalRaisesFuture[void, void]" href="libp2p/muxers/mplex/mplex.html#close.e%2CMplex">mplex: close(m: Mplex): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxer: close(m: Muxer): Future[void]" href="libp2p/muxers/muxer.html#close.e%2CMuxer">muxer: close(m: Muxer): Future[void]</a></li>
|
||||
data-doc-search-tag="muxer: close(m: Muxer): InternalRaisesFuture[void, void]" href="libp2p/muxers/muxer.html#close.e%2CMuxer">muxer: close(m: Muxer): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: close(m: Yamux): Future[void]" href="libp2p/muxers/yamux/yamux.html#close.e%2CYamux">yamux: close(m: Yamux): Future[void]</a></li>
|
||||
data-doc-search-tag="yamux: close(m: Yamux): InternalRaisesFuture[void, void]" href="libp2p/muxers/yamux/yamux.html#close.e%2CYamux">yamux: close(m: Yamux): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: close(s: LPStream): Future[void]" href="libp2p/stream/lpstream.html#close.e%2CLPStream">lpstream: close(s: LPStream): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: close(s: LPStream): InternalRaisesFuture[void, void]" href="libp2p/stream/lpstream.html#close.e%2CLPStream">lpstream: close(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="closed" href="#closed"><span>closed:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -677,27 +677,27 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="closeImpl" href="#closeImpl"><span>closeImpl:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: closeImpl(channel: YamuxChannel): Future[void]" href="libp2p/muxers/yamux/yamux.html#closeImpl.e%2CYamuxChannel">yamux: closeImpl(channel: YamuxChannel): Future[void]</a></li>
|
||||
data-doc-search-tag="yamux: closeImpl(channel: YamuxChannel): InternalRaisesFuture[void, void]" href="libp2p/muxers/yamux/yamux.html#closeImpl.e%2CYamuxChannel">yamux: closeImpl(channel: YamuxChannel): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rconn: closeImpl(self: RelayConnection): Future[void]" href="libp2p/protocols/connectivity/relay/rconn.html#closeImpl.e%2CRelayConnection">rconn: closeImpl(self: RelayConnection): Future[void]</a></li>
|
||||
data-doc-search-tag="rconn: closeImpl(self: RelayConnection): InternalRaisesFuture[void, void]" href="libp2p/protocols/connectivity/relay/rconn.html#closeImpl.e%2CRelayConnection">rconn: closeImpl(self: RelayConnection): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="noise: closeImpl(s: NoiseConnection): Future[void]" href="libp2p/protocols/secure/noise.html#closeImpl.e%2CNoiseConnection">noise: closeImpl(s: NoiseConnection): Future[void]</a></li>
|
||||
data-doc-search-tag="noise: closeImpl(s: NoiseConnection): InternalRaisesFuture[void, void]" href="libp2p/protocols/secure/noise.html#closeImpl.e%2CNoiseConnection">noise: closeImpl(s: NoiseConnection): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="secure: closeImpl(s: SecureConn): Future[void]" href="libp2p/protocols/secure/secure.html#closeImpl.e%2CSecureConn">secure: closeImpl(s: SecureConn): Future[void]</a></li>
|
||||
data-doc-search-tag="secure: closeImpl(s: SecureConn): InternalRaisesFuture[void, void]" href="libp2p/protocols/secure/secure.html#closeImpl.e%2CSecureConn">secure: closeImpl(s: SecureConn): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="bufferstream: closeImpl(s: BufferStream): Future[void]" href="libp2p/stream/bufferstream.html#closeImpl.e%2CBufferStream">bufferstream: closeImpl(s: BufferStream): Future[void]</a></li>
|
||||
data-doc-search-tag="bufferstream: closeImpl(s: BufferStream): InternalRaisesFuture[void, void]" href="libp2p/stream/bufferstream.html#closeImpl.e%2CBufferStream">bufferstream: closeImpl(s: BufferStream): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="chronosstream: closeImpl(s: ChronosStream): Future[void]" href="libp2p/stream/chronosstream.html#closeImpl.e%2CChronosStream">chronosstream: closeImpl(s: ChronosStream): Future[void]</a></li>
|
||||
data-doc-search-tag="chronosstream: closeImpl(s: ChronosStream): InternalRaisesFuture[void, void]" href="libp2p/stream/chronosstream.html#closeImpl.e%2CChronosStream">chronosstream: closeImpl(s: ChronosStream): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connection: closeImpl(s: Connection): Future[void]" href="libp2p/stream/connection.html#closeImpl.e%2CConnection">connection: closeImpl(s: Connection): Future[void]</a></li>
|
||||
data-doc-search-tag="connection: closeImpl(s: Connection): InternalRaisesFuture[void, void]" href="libp2p/stream/connection.html#closeImpl.e%2CConnection">connection: closeImpl(s: Connection): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: closeImpl(s: LPStream): Future[void]" href="libp2p/stream/lpstream.html#closeImpl.e%2CLPStream">lpstream: closeImpl(s: LPStream): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: closeImpl(s: LPStream): InternalRaisesFuture[void, void]" href="libp2p/stream/lpstream.html#closeImpl.e%2CLPStream">lpstream: closeImpl(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: closeImpl(s: WsStream): Future[void]" href="libp2p/transports/wstransport.html#closeImpl.e%2CWsStream">wstransport: closeImpl(s: WsStream): Future[void]</a></li>
|
||||
data-doc-search-tag="wstransport: closeImpl(s: WsStream): InternalRaisesFuture[void, void]" href="libp2p/transports/wstransport.html#closeImpl.e%2CWsStream">wstransport: closeImpl(s: WsStream): InternalRaisesFuture[void, void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="closeWithEOF" href="#closeWithEOF"><span>closeWithEOF:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: closeWithEOF(s: LPStream): Future[void]" href="libp2p/stream/lpstream.html#closeWithEOF%2CLPStream">lpstream: closeWithEOF(s: LPStream): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]" href="libp2p/stream/lpstream.html#closeWithEOF%2CLPStream">lpstream: closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cmp" href="#cmp"><span>cmp:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -1929,9 +1929,9 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
matchers = newSeq[Matcher](); active: bool = false): Future[string]" href="libp2p/multistream.html#handle%2CtypeMultistreamSelect%2CConnection%2Cseq%5Bstring%5D%2Cbool">multistream: handle(_: type MultistreamSelect; conn: Connection; protos: seq[string];
|
||||
matchers = newSeq[Matcher](); active: bool = false): Future[string]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxer: handle(m: Muxer): Future[void]" href="libp2p/muxers/muxer.html#handle.e%2CMuxer">muxer: handle(m: Muxer): Future[void]</a></li>
|
||||
data-doc-search-tag="muxer: handle(m: Muxer): InternalRaisesFuture[void, void]" href="libp2p/muxers/muxer.html#handle.e%2CMuxer">muxer: handle(m: Muxer): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: handle(m: Yamux): Future[void]" href="libp2p/muxers/yamux/yamux.html#handle.e%2CYamux">yamux: handle(m: Yamux): Future[void]</a></li>
|
||||
data-doc-search-tag="yamux: handle(m: Yamux): InternalRaisesFuture[void, void]" href="libp2p/muxers/yamux/yamux.html#handle.e%2CYamux">yamux: handle(m: Yamux): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: handle(p: PubSubPeer; conn: Connection): Future[void]" href="libp2p/protocols/pubsub/pubsubpeer.html#handle%2CPubSubPeer%2CConnection">pubsubpeer: handle(p: PubSubPeer; conn: Connection): Future[void]</a></li>
|
||||
</ul></dd>
|
||||
|
|
@ -3281,11 +3281,17 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="newStream" href="#newStream"><span>newStream:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="mplex: newStream(m: Mplex; name: string = ""; lazy: bool = false): Future[Connection]" href="libp2p/muxers/mplex/mplex.html#newStream.e%2CMplex%2Cstring%2Cbool">mplex: newStream(m: Mplex; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
data-doc-search-tag="mplex: newStream(m: Mplex; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]" href="libp2p/muxers/mplex/mplex.html#newStream.e%2CMplex%2Cstring%2Cbool">mplex: newStream(m: Mplex; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxer: newStream(m: Muxer; name: string = ""; lazy: bool = false): Future[Connection]" href="libp2p/muxers/muxer.html#newStream.e%2CMuxer%2Cstring%2Cbool">muxer: newStream(m: Muxer; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
data-doc-search-tag="muxer: newStream(m: Muxer; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]" href="libp2p/muxers/muxer.html#newStream.e%2CMuxer%2Cstring%2Cbool">muxer: newStream(m: Muxer; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: newStream(m: Yamux; name: string = ""; lazy: bool = false): Future[Connection]" href="libp2p/muxers/yamux/yamux.html#newStream.e%2CYamux%2Cstring%2Cbool">yamux: newStream(m: Yamux; name: string = ""; lazy: bool = false): Future[Connection]</a></li>
|
||||
data-doc-search-tag="yamux: newStream(m: Yamux; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]" href="libp2p/muxers/yamux/yamux.html#newStream.e%2CYamux%2Cstring%2Cbool">yamux: newStream(m: Yamux; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newSwitch" href="#newSwitch"><span>newSwitch:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -3683,11 +3689,15 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="pushData" href="#pushData"><span>pushData:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="bufferstream: pushData(s: BufferStream; data: seq[byte]): Future[void]" href="libp2p/stream/bufferstream.html#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D">bufferstream: pushData(s: BufferStream; data: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="bufferstream: pushData(s: BufferStream; data: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/bufferstream.html#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D">bufferstream: pushData(s: BufferStream; data: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="pushEof" href="#pushEof"><span>pushEof:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="bufferstream: pushEof(s: BufferStream): Future[void]" href="libp2p/stream/bufferstream.html#pushEof.e%2CBufferStream">bufferstream: pushEof(s: BufferStream): Future[void]</a></li>
|
||||
data-doc-search-tag="bufferstream: pushEof(s: BufferStream): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/bufferstream.html#pushEof.e%2CBufferStream">bufferstream: pushEof(s: BufferStream): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="put" href="#put"><span>put:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -3777,43 +3787,69 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="readExactly" href="#readExactly"><span>readExactly:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: readExactly(s: LPStream; pbytes: pointer; nbytes: int): Future[void]" href="libp2p/stream/lpstream.html#readExactly%2CLPStream%2Cpointer%2Cint">lpstream: readExactly(s: LPStream; pbytes: pointer; nbytes: int): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#readExactly%2CLPStream%2Cpointer%2Cint">lpstream: readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readLine" href="#readLine"><span>readLine:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: readLine(s: LPStream; limit = 0; sep = "\r
|
||||
"): Future[string]" href="libp2p/stream/lpstream.html#readLine%2CLPStream%2Cint%2Cstring">lpstream: readLine(s: LPStream; limit = 0; sep = "\r
|
||||
"): Future[string]</a></li>
|
||||
"): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#readLine%2CLPStream%2Cint%2Cstring">lpstream: readLine(s: LPStream; limit = 0; sep = "\r
|
||||
"): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readLp" href="#readLp"><span>readLp:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: readLp(s: LPStream; maxSize: int): Future[seq[byte]]" href="libp2p/stream/lpstream.html#readLp%2CLPStream%2Cint">lpstream: readLp(s: LPStream; maxSize: int): Future[seq[byte]]</a></li>
|
||||
data-doc-search-tag="lpstream: readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#readLp%2CLPStream%2Cint">lpstream: readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readMessage" href="#readMessage"><span>readMessage:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="noise: readMessage(sconn: NoiseConnection): Future[seq[byte]]" href="libp2p/protocols/secure/noise.html#readMessage.e%2CNoiseConnection">noise: readMessage(sconn: NoiseConnection): Future[seq[byte]]</a></li>
|
||||
data-doc-search-tag="noise: readMessage(sconn: NoiseConnection): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/secure/noise.html#readMessage.e%2CNoiseConnection">noise: readMessage(sconn: NoiseConnection): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="secure: readMessage(c: SecureConn): Future[seq[byte]]" href="libp2p/protocols/secure/secure.html#readMessage.e%2CSecureConn">secure: readMessage(c: SecureConn): Future[seq[byte]]</a></li>
|
||||
data-doc-search-tag="secure: readMessage(c: SecureConn): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/secure/secure.html#readMessage.e%2CSecureConn">secure: readMessage(c: SecureConn): InternalRaisesFuture[seq[byte],
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readMsg" href="#readMsg"><span>readMsg:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="coder: readMsg(conn: Connection): Future[Msg]" href="libp2p/muxers/mplex/coder.html#readMsg%2CConnection">coder: readMsg(conn: Connection): Future[Msg]</a></li>
|
||||
data-doc-search-tag="coder: readMsg(conn: Connection): InternalRaisesFuture[Msg,
|
||||
(CancelledError, LPStreamError, MuxerError)]" href="libp2p/muxers/mplex/coder.html#readMsg%2CConnection">coder: readMsg(conn: Connection): InternalRaisesFuture[Msg,
|
||||
(CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readOnce" href="#readOnce"><span>readOnce:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/muxers/yamux/yamux.html#readOnce.e%2CYamuxChannel%2Cpointer%2Cint">yamux: readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="yamux: readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]" href="libp2p/muxers/yamux/yamux.html#readOnce.e%2CYamuxChannel%2Cpointer%2Cint">yamux: readOnce(channel: YamuxChannel; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rconn: readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/protocols/connectivity/relay/rconn.html#readOnce.e%2CRelayConnection%2Cpointer%2Cint">rconn: readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="rconn: readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]" href="libp2p/protocols/connectivity/relay/rconn.html#readOnce.e%2CRelayConnection%2Cpointer%2Cint">rconn: readOnce(self: RelayConnection; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="secure: readOnce(s: SecureConn; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/protocols/secure/secure.html#readOnce.e%2CSecureConn%2Cpointer%2Cint">secure: readOnce(s: SecureConn; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="secure: readOnce(s: SecureConn; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/secure/secure.html#readOnce.e%2CSecureConn%2Cpointer%2Cint">secure: readOnce(s: SecureConn; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="bufferstream: readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/stream/bufferstream.html#readOnce.e%2CBufferStream%2Cpointer%2Cint">bufferstream: readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="bufferstream: readOnce(s: BufferStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]" href="libp2p/stream/bufferstream.html#readOnce.e%2CBufferStream%2Cpointer%2Cint">bufferstream: readOnce(s: BufferStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="chronosstream: readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/stream/chronosstream.html#readOnce.e%2CChronosStream%2Cpointer%2Cint">chronosstream: readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="chronosstream: readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]" href="libp2p/stream/chronosstream.html#readOnce.e%2CChronosStream%2Cpointer%2Cint">chronosstream: readOnce(s: ChronosStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
|
||||
int, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: readOnce(s: LPStream; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/stream/lpstream.html#readOnce.e%2CLPStream%2Cpointer%2Cint">lpstream: readOnce(s: LPStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="lpstream: readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#readOnce.e%2CLPStream%2Cpointer%2Cint">lpstream: readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: readOnce(s: WsStream; pbytes: pointer; nbytes: int): Future[int]" href="libp2p/transports/wstransport.html#readOnce.e%2CWsStream%2Cpointer%2Cint">wstransport: readOnce(s: WsStream; pbytes: pointer; nbytes: int): Future[int]</a></li>
|
||||
data-doc-search-tag="wstransport: readOnce(s: WsStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/transports/wstransport.html#readOnce.e%2CWsStream%2Cpointer%2Cint">wstransport: readOnce(s: WsStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="readSeq" href="#readSeq"><span>readSeq:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -3821,7 +3857,9 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="readVarint" href="#readVarint"><span>readVarint:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: readVarint(conn: LPStream): Future[uint64]" href="libp2p/stream/lpstream.html#readVarint%2CLPStream">lpstream: readVarint(conn: LPStream): Future[uint64]</a></li>
|
||||
data-doc-search-tag="lpstream: readVarint(conn: LPStream): InternalRaisesFuture[uint64,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#readVarint%2CLPStream">lpstream: readVarint(conn: LPStream): InternalRaisesFuture[uint64,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="vbuffer: readVarint(vb: var VBuffer; value: var LPSomeUVarint): int" href="libp2p/vbuffer.html#readVarint%2CVBuffer%2CLPSomeUVarint">vbuffer: readVarint(vb: var VBuffer; value: var LPSomeUVarint): int</a></li>
|
||||
</ul></dd>
|
||||
|
|
@ -5127,7 +5165,9 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="multihash: write(vb: var VBuffer; mh: MultiHash)" href="libp2p/multihash.html#write%2CVBuffer%2CMultiHash">multihash: write(vb: var VBuffer; mh: MultiHash)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: write(channel: YamuxChannel; msg: seq[byte]): Future[void]" href="libp2p/muxers/yamux/yamux.html#write.e%2CYamuxChannel%2Cseq%5Bbyte%5D">yamux: write(channel: YamuxChannel; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="yamux: write(channel: YamuxChannel; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/muxers/yamux/yamux.html#write.e%2CYamuxChannel%2Cseq%5Bbyte%5D">yamux: write(channel: YamuxChannel; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="peerid: write(pb: var ProtoBuffer; field: int; pid: PeerId)" href="libp2p/peerid.html#write%2CProtoBuffer%2Cint%2CPeerId">peerid: write(pb: var ProtoBuffer; field: int; pid: PeerId)</a></li>
|
||||
<li><a class="reference external"
|
||||
|
|
@ -5139,7 +5179,9 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="minprotobuf: write[T: ProtoScalar](pb: var ProtoBuffer; field: int; value: T)" href="libp2p/protobuf/minprotobuf.html#write%2CProtoBuffer%2Cint%2CT">minprotobuf: write[T: ProtoScalar](pb: var ProtoBuffer; field: int; value: T)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rconn: write(self: RelayConnection; msg: seq[byte]): Future[void]" href="libp2p/protocols/connectivity/relay/rconn.html#write.e%2CRelayConnection%2Cseq%5Bbyte%5D">rconn: write(self: RelayConnection; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="rconn: write(self: RelayConnection; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/connectivity/relay/rconn.html#write.e%2CRelayConnection%2Cseq%5Bbyte%5D">rconn: write(self: RelayConnection; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="protobuf: write(pb: var ProtoBuffer; field: int; graft: ControlGraft)" href="libp2p/protocols/pubsub/rpc/protobuf.html#write%2CProtoBuffer%2Cint%2CControlGraft">protobuf: write(pb: var ProtoBuffer; field: int; graft: ControlGraft)</a></li>
|
||||
<li><a class="reference external"
|
||||
|
|
@ -5157,17 +5199,27 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="protobuf: write(pb: var ProtoBuffer; field: int; subs: SubOpts)" href="libp2p/protocols/pubsub/rpc/protobuf.html#write%2CProtoBuffer%2Cint%2CSubOpts">protobuf: write(pb: var ProtoBuffer; field: int; subs: SubOpts)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="noise: write(sconn: NoiseConnection; message: seq[byte]): Future[void]" href="libp2p/protocols/secure/noise.html#write.e%2CNoiseConnection%2Cseq%5Bbyte%5D">noise: write(sconn: NoiseConnection; message: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="noise: write(sconn: NoiseConnection; message: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/secure/noise.html#write.e%2CNoiseConnection%2Cseq%5Bbyte%5D">noise: write(sconn: NoiseConnection; message: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="signed_envelope: write(pb: var ProtoBuffer; field: int; env: Envelope): Result[void, CryptoError]" href="libp2p/signed_envelope.html#write%2CProtoBuffer%2Cint%2CEnvelope">signed_envelope: write(pb: var ProtoBuffer; field: int; env: Envelope): Result[void, CryptoError]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="chronosstream: write(s: ChronosStream; msg: seq[byte]): Future[void]" href="libp2p/stream/chronosstream.html#write.e%2CChronosStream%2Cseq%5Bbyte%5D">chronosstream: write(s: ChronosStream; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="chronosstream: write(s: ChronosStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/chronosstream.html#write.e%2CChronosStream%2Cseq%5Bbyte%5D">chronosstream: write(s: ChronosStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: write(s: LPStream; msg: string): Future[void]" href="libp2p/stream/lpstream.html#write%2CLPStream%2Cstring">lpstream: write(s: LPStream; msg: string): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: write(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#write%2CLPStream%2Cstring">lpstream: write(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: write(s: LPStream; msg: seq[byte]): Future[void]" href="libp2p/stream/lpstream.html#write.e%2CLPStream%2Cseq%5Bbyte%5D">lpstream: write(s: LPStream; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#write.e%2CLPStream%2Cseq%5Bbyte%5D">lpstream: write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: write(s: WsStream; msg: seq[byte]): Future[void]" href="libp2p/transports/wstransport.html#write.e%2CWsStream%2Cseq%5Bbyte%5D">wstransport: write(s: WsStream; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="wstransport: write(s: WsStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/transports/wstransport.html#write.e%2CWsStream%2Cseq%5Bbyte%5D">wstransport: write(s: WsStream; msg: seq[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="writeArray" href="#writeArray"><span>writeArray:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -5175,9 +5227,13 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
</ul></dd>
|
||||
<dt><a name="writeLp" href="#writeLp"><span>writeLp:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: writeLp(s: LPStream; msg: openArray[byte]): Future[void]" href="libp2p/stream/lpstream.html#writeLp%2CLPStream%2CopenArray%5Bbyte%5D">lpstream: writeLp(s: LPStream; msg: openArray[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#writeLp%2CLPStream%2CopenArray%5Bbyte%5D">lpstream: writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: writeLp(s: LPStream; msg: string): Future[void]" href="libp2p/stream/lpstream.html#writeLp%2CLPStream%2Cstring">lpstream: writeLp(s: LPStream; msg: string): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/stream/lpstream.html#writeLp%2CLPStream%2Cstring">lpstream: writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="writeLPVarint" href="#writeLPVarint"><span>writeLPVarint:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -5186,12 +5242,14 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<dt><a name="writeMsg" href="#writeMsg"><span>writeMsg:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): Future[void]" href="libp2p/muxers/mplex/coder.html#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cseq%5Bbyte%5D">coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): Future[void]</a></li>
|
||||
data: seq[byte] = @[]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/muxers/mplex/coder.html#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cseq%5Bbyte%5D">coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType;
|
||||
data: seq[byte] = @[]): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): Future[
|
||||
void]" href="libp2p/muxers/mplex/coder.html#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cstring">coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): Future[
|
||||
void]</a></li>
|
||||
data-doc-search-tag="coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]" href="libp2p/muxers/mplex/coder.html#writeMsg%2CConnection%2Cuint64%2CMessageType%2Cstring">coder: writeMsg(conn: Connection; id: uint64; msgType: MessageType; data: string): InternalRaisesFuture[
|
||||
void, (CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="writePacked" href="#writePacked"><span>writePacked:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -5282,7 +5340,7 @@ window.addEventListener('DOMContentLoaded', main);
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-04 18:40:00 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-05 07:08:14 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue