mirror of
https://github.com/status-im/nim-libp2p.git
synced 2025-01-27 13:14:58 +00:00
update docs for message-id-mem
This commit is contained in:
=
parent
dfc9d1c502
commit
5f4668ef60
@ -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-19 14:51:31 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -306,6 +306,11 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li><a class="reference" href="#getConnections%2CConnManager"
|
||||
title="getConnections(c: ConnManager): Table[PeerId, seq[Muxer]]">getConnections(c: ConnManager): Table[PeerId, seq[Muxer]]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getIncomingSlot
|
||||
<li><a class="reference" href="#getIncomingSlot%2CConnManager"
|
||||
title="getIncomingSlot(c: ConnManager): Future[ConnectionSlot]">getIncomingSlot(c: ConnManager): Future[ConnectionSlot]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getOutgoingSlot
|
||||
<li><a class="reference" href="#getOutgoingSlot%2CConnManager"
|
||||
@ -313,7 +318,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getStream
|
||||
<li><a class="reference" href="#getStream%2CConnManager%2CPeerId"
|
||||
<li><a class="reference" href="#getStream%2CConnManager%2CMuxer"
|
||||
title="getStream(c: ConnManager; muxer: Muxer): Future[Connection]">getStream(c: ConnManager; muxer: Muxer): Future[Connection]</a></li>
|
||||
<li><a class="reference" href="#getStream%2CConnManager%2CPeerId"
|
||||
title="getStream(c: ConnManager; peerId: PeerId): Future[Connection]">getStream(c: ConnManager; peerId: PeerId): Future[Connection]</a></li>
|
||||
<li><a class="reference" href="#getStream%2CConnManager%2CPeerId%2CDirection"
|
||||
title="getStream(c: ConnManager; peerId: PeerId; dir: Direction): Future[Connection]">getStream(c: ConnManager; peerId: PeerId; dir: Direction): Future[Connection]</a></li>
|
||||
@ -349,11 +356,6 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li><a class="reference" href="#selectMuxer%2CConnManager%2CPeerId"
|
||||
title="selectMuxer(c: ConnManager; peerId: PeerId): Muxer">selectMuxer(c: ConnManager; peerId: PeerId): Muxer</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">storeMuxer
|
||||
<li><a class="reference" href="#storeMuxer%2CConnManager%2CMuxer"
|
||||
title="storeMuxer(c: ConnManager; muxer: Muxer)">storeMuxer(c: ConnManager; muxer: Muxer)</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">trackConnection
|
||||
<li><a class="reference" href="#trackConnection%2CConnectionSlot%2CConnection"
|
||||
@ -602,15 +604,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="close,ConnManager" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#close%2CConnManager"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</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">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">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="#close%2CConnManager"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</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>
|
||||
|
||||
cleanup resources for the connection manager
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L416"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L418"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L416" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L418" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -652,20 +654,20 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="dropPeer,ConnManager,PeerId" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#dropPeer%2CConnManager%2CPeerId"><span class="Identifier">dropPeer</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</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">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">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>
|
||||
<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>
|
||||
|
||||
drop connections and cleanup resources for peer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L405"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L407"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L405" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L407" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="expectConnection,ConnManager,PeerId,Direction" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#expectConnection%2CConnManager%2CPeerId%2CDirection"><span class="Identifier">expectConnection</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">p</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">Direction</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">Muxer</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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -688,6 +690,20 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connman
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getIncomingSlot,ConnManager" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getIncomingSlot%2CConnManager"><span class="Identifier">getIncomingSlot</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="peerstore.html#ConnectionSlot"><span class="Identifier">ConnectionSlot</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/message-id-mem/libp2p/connmanager.nim#L336"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L336" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getOutgoingSlot,ConnManager" class="tohide">
|
||||
@ -697,37 +713,51 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L338"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L340"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L338" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L340" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getStream,ConnManager,Muxer" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getStream%2CConnManager%2CMuxer"><span class="Identifier">getStream</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><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">Connection</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>
|
||||
|
||||
get a muxed stream for the passed muxer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L384"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L384" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getStream,ConnManager,PeerId" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getStream%2CConnManager%2CPeerId"><span class="Identifier">getStream</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">Connection</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><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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getStream%2CConnManager%2CPeerId"><span class="Identifier">getStream</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">Connection</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>
|
||||
|
||||
get a muxed stream for the passed peer from any connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L390"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L392"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L390" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L392" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getStream,ConnManager,PeerId,Direction" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getStream%2CConnManager%2CPeerId%2CDirection"><span class="Identifier">getStream</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">Direction</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<span class="Identifier">Connection</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><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">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">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>
|
||||
<span class="Identifier">Connection</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>
|
||||
|
||||
get a muxed stream for the passed peer from a connection with <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L398"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L400"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L398" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L400" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -751,9 +781,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L354"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L356"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L354" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L356" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -793,19 +823,6 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connman
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L271" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="storeMuxer,ConnManager,Muxer" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#storeMuxer%2CConnManager%2CMuxer"><span class="Identifier">storeMuxer</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">muxer</span><span class="Other">:</span> <span class="Identifier">Muxer</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="Identifier">CatchableError</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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
store the connection and muxer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L283"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L283" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="trackConnection,ConnectionSlot,Connection" class="tohide">
|
||||
@ -815,9 +832,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L360"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L362"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L360" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L362" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -827,16 +844,16 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L375"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/connmanager.nim#L377"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L375" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/connmanager.nim#L377" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="triggerPeerEvents,ConnManager,PeerId,PeerEvent" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#triggerPeerEvents%2CConnManager%2CPeerId%2CPeerEvent"><span class="Identifier">triggerPeerEvents</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="peerstore.html#ConnManager"><span class="Identifier">ConnManager</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">event</span><span class="Other">:</span> <a href="peerstore.html#PeerEvent"><span class="Identifier">PeerEvent</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><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">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">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>
|
||||
<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>
|
||||
|
||||
|
||||
@ -857,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:54 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:52 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:52 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:52 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -225,8 +225,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
PeerId]</a></li>
|
||||
<li><a class="reference" href="#connect.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D"
|
||||
title="connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]">connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]</a></li>
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]">connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">dial
|
||||
@ -301,7 +301,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="connect.e,Dial,MultiAddress" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#connect.e%2CDial%2CMultiAddress"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dial.html#Dial"><span class="Identifier">Dial</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span> <span class="Identifier">allowUnknownPeerId</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="peerid.html#PeerId"><span class="Identifier">PeerId</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">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>
|
||||
<a href="peerid.html#PeerId"><span class="Identifier">PeerId</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>
|
||||
<dd>
|
||||
|
||||
@ -315,10 +315,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="connect.e,Dial,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#connect.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dial.html#Dial"><span class="Identifier">Dial</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">forceDial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">reuseConnection</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
|
||||
<span class="Identifier">upgradeDir</span> <span class="Other">=</span> <a href="stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">.</span><span class="Identifier">Out</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">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">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>
|
||||
<span class="Identifier">forceDial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">reuseConnection</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <a href="stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">.</span><span class="Identifier">Out</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>
|
||||
<dd>
|
||||
|
||||
connect remote peer without negotiating a protocol
|
||||
@ -332,7 +331,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="dial.e,Dial,PeerId,seq[MultiAddress],seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D%2Cseq%5Bstring%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dial.html#Dial"><span class="Identifier">Dial</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">forceDial</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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -346,7 +345,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="dial.e,Dial,PeerId,seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CDial%2CPeerId%2Cseq%5Bstring%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dial.html#Dial"><span class="Identifier">Dial</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
@ -360,7 +359,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="tryDial.e,Dial,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#tryDial.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">tryDial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dial.html#Dial"><span class="Identifier">Dial</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</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><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">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">Opt</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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>
|
||||
|
||||
@ -382,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -248,9 +248,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
PeerId]</a></li>
|
||||
<li><a class="reference" href="#connect.e%2CDialer%2CPeerId%2Cseq%5BMultiAddress%5D"
|
||||
title="connect(self: Dialer; peerId: PeerId; addrs: seq[MultiAddress];
|
||||
forceDial = false; reuseConnection = true; upgradeDir = Direction.Out): Future[
|
||||
forceDial = false; reuseConnection = true; dir = Direction.Out): Future[
|
||||
void]">connect(self: Dialer; peerId: PeerId; addrs: seq[MultiAddress];
|
||||
forceDial = false; reuseConnection = true; upgradeDir = Direction.Out): Future[
|
||||
forceDial = false; reuseConnection = true; dir = Direction.Out): Future[
|
||||
void]</a></li>
|
||||
|
||||
</ul>
|
||||
@ -344,9 +344,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L334"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L338"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L334" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L338" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -361,78 +361,77 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L331"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L335"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L331" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L335" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="connect.e,Dialer,MultiAddress" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#connect.e%2CDialer%2CMultiAddress"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dialer.html#Dialer"><span class="Identifier">Dialer</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span> <span class="Identifier">allowUnknownPeerId</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="peerid.html#PeerId"><span class="Identifier">PeerId</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">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>
|
||||
<a href="peerid.html#PeerId"><span class="Identifier">PeerId</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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Connects to a peer and retrieve its PeerId
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L225"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L229"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L225" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L229" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="connect.e,Dialer,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#connect.e%2CDialer%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dialer.html#Dialer"><span class="Identifier">Dialer</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">forceDial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">reuseConnection</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
|
||||
<span class="Identifier">upgradeDir</span> <span class="Other">=</span> <a href="stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">.</span><span class="Identifier">Out</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">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>
|
||||
<span class="Identifier">forceDial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">reuseConnection</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <a href="stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">.</span><span class="Identifier">Out</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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
connect remote peer without negotiating a protocol
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L212"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L216"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L212" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L216" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="dial.e,Dialer,PeerId,seq[MultiAddress],seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CDialer%2CPeerId%2Cseq%5BMultiAddress%5D%2Cseq%5Bstring%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dialer.html#Dialer"><span class="Identifier">Dialer</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">forceDial</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">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>
|
||||
<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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
create a protocol stream and establish a connection if one doesn't exist already
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L295"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L299"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L295" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L299" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="dial.e,Dialer,PeerId,seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CDialer%2CPeerId%2Cseq%5Bstring%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dialer.html#Dialer"><span class="Identifier">Dialer</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</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">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>
|
||||
<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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
create a protocol stream over an existing connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L278"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L282"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L282" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="tryDial.e,Dialer,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#tryDial.e%2CDialer%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">tryDial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="dialer.html#Dialer"><span class="Identifier">Dialer</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</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><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">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">Opt</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Create a protocol stream in order to check if a connection is possible. Doesn't use the Connection Manager to save it.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L257"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/dialer.nim#L261"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/dialer.nim#L261" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -441,7 +440,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="19">
|
||||
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
||||
<dl class="item">
|
||||
<a href="dial.html#dial.e,Dial,PeerId,seq[string]"><span class="Identifier">dial</span></a>, <a href="dial.html#dial.e,Dial,PeerId,seq[MultiAddress],seq[string]"><span class="Identifier">dial</span></a>, <a href="dial.html#connect.e,Dial,PeerId,seq[MultiAddress]"><span class="Identifier">connect</span></a>, <a href="dial.html#tryDial.e,Dial,PeerId,seq[MultiAddress]"><span class="Identifier">tryDial</span></a>, <a href="dial.html#addTransport.e,Dial,Transport"><span class="Identifier">addTransport</span></a>, <a href="dial.html#Dial"><span class="Identifier">Dial</span></a>, <a href="dial.html#connect.e,Dial,MultiAddress"><span class="Identifier">connect</span></a>, <a href="errors.html#toException,cstring"><span class="Identifier">toException</span></a>, <a href="errors.html#toException,string"><span class="Identifier">toException</span></a>, <a href="errors.html#allFuturesThrowing,varargs[Future[T]]"><span class="Identifier">allFuturesThrowing</span></a>, <a href="errors.html#tryAndWarn.t,static[string],untyped"><span class="Identifier">tryAndWarn</span></a>, <a href="errors.html#checkFutures.m,seq[F],untyped"><span class="Identifier">checkFutures</span></a>, <a href="errors.html#LPError"><span class="Identifier">LPError</span></a>
|
||||
<a href="dial.html#dial.e,Dial,PeerId,seq[string]"><span class="Identifier">dial</span></a>, <a href="dial.html#dial.e,Dial,PeerId,seq[MultiAddress],seq[string]"><span class="Identifier">dial</span></a>, <a href="dial.html#connect.e,Dial,PeerId,seq[MultiAddress]"><span class="Identifier">connect</span></a>, <a href="dial.html#tryDial.e,Dial,PeerId,seq[MultiAddress]"><span class="Identifier">tryDial</span></a>, <a href="dial.html#addTransport.e,Dial,Transport"><span class="Identifier">addTransport</span></a>, <a href="dial.html#Dial"><span class="Identifier">Dial</span></a>, <a href="dial.html#connect.e,Dial,MultiAddress"><span class="Identifier">connect</span></a>, <a href="errors.html#toException,cstring"><span class="Identifier">toException</span></a>, <a href="errors.html#toException,string"><span class="Identifier">toException</span></a>, <a href="errors.html#tryAndWarn.t,static[string],untyped"><span class="Identifier">tryAndWarn</span></a>, <a href="errors.html#checkFutures.m,seq[F],untyped"><span class="Identifier">checkFutures</span></a>, <a href="errors.html#LPError"><span class="Identifier">LPError</span></a>
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@ -451,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -207,12 +207,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">allFuturesThrowing
|
||||
<li><a class="reference" href="#allFuturesThrowing%2Cvarargs%5BFuture%5BT%5D%5D"
|
||||
title="allFuturesThrowing[T](args: varargs[Future[T]]): Future[void]">allFuturesThrowing[T](args: varargs[Future[T]]): Future[void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">toException
|
||||
<ul class="simple nested-toc-section">toException
|
||||
<li><a class="reference" href="#toException%2Ccstring"
|
||||
title="toException(e: cstring): ref LPError">toException(e: cstring): ref LPError</a></li>
|
||||
<li><a class="reference" href="#toException%2Cstring"
|
||||
@ -277,18 +272,6 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="allFuturesThrowing,varargs[Future[T]]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#allFuturesThrowing%2Cvarargs%5BFuture%5BT%5D%5D"><span class="Identifier">allFuturesThrowing</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">T</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></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/errors.nim#L48"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/errors.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="toException,cstring" class="tohide">
|
||||
<dt><pre><span class="Keyword">func</span> <a href="#toException%2Ccstring"><span class="Identifier">toException</span></a><span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="errors.html#LPError"><span class="Identifier">LPError</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>
|
||||
@ -341,9 +324,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/errors.nim#L70"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/errors.nim#L48"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/errors.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/errors.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -357,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:54 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -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-19 14:51:27 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -297,9 +297,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L239"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L240"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L239" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L240" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -310,9 +310,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L240"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L241"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L240" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L241" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -327,9 +327,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L244"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L245"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L244" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L245" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -344,9 +344,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Returns <tt class="docutils literal"><span class="pre">true</span></tt> if MultiCodecs <tt class="docutils literal"><span class="pre">a</span></tt> and <tt class="docutils literal"><span class="pre">b</span></tt> are not equal.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L291"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L292"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L291" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L292" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -356,9 +356,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Returns string representation of MultiCodec <tt class="docutils literal"><span class="pre">mc</span></tt>.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L270"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L271"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L270" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L271" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -368,9 +368,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Returns <tt class="docutils literal"><span class="pre">true</span></tt> if MultiCodecs <tt class="docutils literal"><span class="pre">a</span></tt> and <tt class="docutils literal"><span class="pre">b</span></tt> are equal.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L287"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L288"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L287" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L288" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -380,9 +380,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Compares MultiCodec <tt class="docutils literal"><span class="pre">mc</span></tt> with integer <tt class="docutils literal"><span class="pre">code</span></tt>.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L283"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L284"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L283" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L284" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -392,9 +392,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Compares MultiCodec <tt class="docutils literal"><span class="pre">mc</span></tt> with string <tt class="docutils literal"><span class="pre">name</span></tt>.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L276"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L277"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L276" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L277" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -404,9 +404,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Return MultiCodec from integer representation <tt class="docutils literal"><span class="pre">code</span></tt>. If <tt class="docutils literal"><span class="pre">code</span></tt> is not valid multicodec code, then <tt class="docutils literal"><span class="pre">InvalidMultiCodec</span></tt> will be returned.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L305"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L306"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L305" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L306" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -417,9 +417,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Return MultiCodec from string representation <tt class="docutils literal"><span class="pre">name</span></tt>. If <tt class="docutils literal"><span class="pre">name</span></tt> is not valid multicodec name, then <tt class="docutils literal"><span class="pre">InvalidMultiCodec</span></tt> will be returned.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L299"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L300"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L299" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L300" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -429,9 +429,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Hash procedure for tables.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L295"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L296"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L295" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L296" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -441,9 +441,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Generate MultiCodec from integer <tt class="docutils literal"><span class="pre">code</span></tt> at compile time.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L264"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L265"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L265" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -453,9 +453,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Generate MultiCodec from string <tt class="docutils literal"><span class="pre">name</span></tt> at compile time.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L258"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L259"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L258" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L259" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -465,9 +465,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Write MultiCodec to buffer <tt class="docutils literal"><span class="pre">vb</span></tt>.
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L315"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multicodec.nim#L316"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L315" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L316" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</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-19 14:51:27 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:54 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -243,17 +243,21 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<ul class="simple nested-toc-section">handle
|
||||
<li><a class="reference" href="#handle%2CtypeMultistreamSelect%2CConnection%2Cseq%5Bstring%5D%2Cbool"
|
||||
title="handle(_: type MultistreamSelect; conn: Connection; protos: seq[string];
|
||||
matchers = newSeq[Matcher](); active: bool = false): Future[string]">handle(_: type MultistreamSelect; conn: Connection; protos: seq[string];
|
||||
matchers = newSeq[Matcher](); active: bool = false): Future[string]</a></li>
|
||||
matchers = newSeq[Matcher](); active: bool = false): InternalRaisesFuture[
|
||||
string, (CancelledError, LPStreamError, MultiStreamError)]">handle(_: type MultistreamSelect; conn: Connection; protos: seq[string];
|
||||
matchers = newSeq[Matcher](); active: bool = false): InternalRaisesFuture[
|
||||
string, (CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
<li><a class="reference" href="#handle%2CMultistreamSelect%2CConnection%2Cbool"
|
||||
title="handle(m: MultistreamSelect; conn: Connection; active: bool = false): Future[
|
||||
void]">handle(m: MultistreamSelect; conn: Connection; active: bool = false): Future[
|
||||
void]</a></li>
|
||||
title="handle(m: MultistreamSelect; conn: Connection; active: bool = false): InternalRaisesFuture[
|
||||
void, (CancelledError,)]">handle(m: MultistreamSelect; conn: Connection; active: bool = false): InternalRaisesFuture[
|
||||
void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">list
|
||||
<li><a class="reference" href="#list%2CMultistreamSelect%2CConnection"
|
||||
title="list(m: MultistreamSelect; conn: Connection): Future[seq[string]]">list(m: MultistreamSelect; conn: Connection): Future[seq[string]]</a></li>
|
||||
title="list(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[seq[string],
|
||||
(CancelledError, LPStreamError, MultiStreamError)]">list(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[seq[string],
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">new
|
||||
@ -264,24 +268,30 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<ul class="simple nested-toc-section">select
|
||||
<li><a class="reference" href="#select%2C%2CConnection%2Cseq%5Bstring%5D"
|
||||
title="select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): Future[string]">select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): Future[string]</a></li>
|
||||
proto: seq[string]): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]">select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
<li><a class="reference" href="#select%2C%2CConnection%2Cstring"
|
||||
title="select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): Future[bool]">select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): Future[bool]</a></li>
|
||||
proto: string): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]">select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
<li><a class="reference" href="#select%2CMultistreamSelect%2CConnection"
|
||||
title="select(m: MultistreamSelect; conn: Connection): Future[bool]">select(m: MultistreamSelect; conn: Connection): Future[bool]</a></li>
|
||||
title="select(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]">select(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">start
|
||||
<li><a class="reference" href="#start%2CMultistreamSelect"
|
||||
title="start(m: MultistreamSelect): Future[void]">start(m: MultistreamSelect): Future[void]</a></li>
|
||||
title="start(m: MultistreamSelect): InternalRaisesFuture[void, (CancelledError,)]">start(m: MultistreamSelect): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">stop
|
||||
<li><a class="reference" href="#stop%2CMultistreamSelect"
|
||||
title="stop(m: MultistreamSelect): Future[void]">stop(m: MultistreamSelect): Future[void]</a></li>
|
||||
title="stop(m: MultistreamSelect): InternalRaisesFuture[void, void]">stop(m: MultistreamSelect): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -376,9 +386,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
helper to allow registering pure handlers
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L232"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L249"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L232" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -389,9 +399,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L226"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L243"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L226" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L243" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -402,51 +412,53 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L217"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L234"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L217" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L234" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handle,typeMultistreamSelect,Connection,seq[string],bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#handle%2CtypeMultistreamSelect%2CConnection%2Cseq%5Bstring%5D%2Cbool"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Keyword">type</span> <span class="Identifier">MultistreamSelect</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="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">matchers</span> <span class="Other">=</span> <span class="Identifier">newSeq</span><span class="Other">[</span><a href="multistream.html#Matcher"><span class="Identifier">Matcher</span></a><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">active</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><span class="Identifier">string</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><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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<span class="Identifier">matchers</span> <span class="Other">=</span> <span class="Identifier">newSeq</span><span class="Other">[</span><a href="multistream.html#Matcher"><span class="Identifier">Matcher</span></a><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">active</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>
|
||||
<span class="Identifier">string</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> <a href="multistream.html#MultiStreamError"><span class="Identifier">MultiStreamError</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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L134"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L147"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L147" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handle,MultistreamSelect,Connection,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#handle%2CMultistreamSelect%2CConnection%2Cbool"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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">active</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>
|
||||
<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><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">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">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="#handle%2CMultistreamSelect%2CConnection%2Cbool"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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">active</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>
|
||||
<span class="Identifier">void</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</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">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/message-id-mem/libp2p/multistream.nim#L175"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L192"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L175" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L192" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="list,MultistreamSelect,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#list%2CMultistreamSelect%2CConnection"><span class="Identifier">list</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#list%2CMultistreamSelect%2CConnection"><span class="Identifier">list</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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>
|
||||
<span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</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> <a href="multistream.html#MultiStreamError"><span class="Identifier">MultiStreamError</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>
|
||||
|
||||
list remote protos requests on connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L113"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L125"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L125" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -464,68 +476,73 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="select,,Connection,seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#select%2C%2CConnection%2Cseq%5Bstring%5D"><span class="Identifier">select</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</span></a> <span class="Operator">|</span> <span class="Keyword">type</span> <span class="Identifier">MultistreamSelect</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="Identifier">proto</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</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">string</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<span class="Identifier">proto</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</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">string</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> <a href="multistream.html#MultiStreamError"><span class="Identifier">MultiStreamError</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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L56"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L58"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="select,,Connection,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#select%2C%2CConnection%2Cstring"><span class="Identifier">select</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</span></a> <span class="Operator">|</span> <span class="Keyword">type</span> <span class="Identifier">MultistreamSelect</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="Identifier">proto</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">bool</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<span class="Identifier">proto</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">bool</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> <a href="multistream.html#MultiStreamError"><span class="Identifier">MultiStreamError</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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L103"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L108"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L103" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="select,MultistreamSelect,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#select%2CMultistreamSelect%2CConnection"><span class="Identifier">select</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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><span class="Identifier">bool</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>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#select%2CMultistreamSelect%2CConnection"><span class="Identifier">select</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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><span class="Identifier">bool</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> <a href="multistream.html#MultiStreamError"><span class="Identifier">MultiStreamError</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/message-id-mem/libp2p/multistream.nim#L118"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start,MultistreamSelect" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#start%2CMultistreamSelect"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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><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/message-id-mem/libp2p/multistream.nim#L109"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L263"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L109" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start,MultistreamSelect" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#start%2CMultistreamSelect"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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">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">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/message-id-mem/libp2p/multistream.nim#L246"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L246" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L263" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop,MultistreamSelect" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#stop%2CMultistreamSelect"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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">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">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="#stop%2CMultistreamSelect"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="multistream.html#MultistreamSelect"><span class="Identifier">MultistreamSelect</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/message-id-mem/libp2p/multistream.nim#L249"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/multistream.nim#L284"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multistream.nim#L284" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -539,7 +556,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/mplex/coder.nim#L45"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/mplex/coder.nim#L58"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/mplex/coder.nim#L87"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -244,10 +244,22 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">getStreams
|
||||
<ul class="simple nested-toc-section">close
|
||||
<li><a class="reference" href="#close.e%2CMplex"
|
||||
title="close(m: Mplex): InternalRaisesFuture[void, void]">close(m: Mplex): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getStreams
|
||||
<li><a class="reference" href="#getStreams.e%2CMplex"
|
||||
title="getStreams(m: Mplex): seq[Connection]">getStreams(m: Mplex): seq[Connection]</a></li>
|
||||
|
||||
</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): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]">newStream(m: Mplex; name: string = ""; lazy: bool = false): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError, MuxerError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</ul>
|
||||
@ -348,9 +360,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/mplex/mplex.nim#L201"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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>
|
||||
@ -371,15 +383,43 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="14">
|
||||
<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">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/message-id-mem/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#L224" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getStreams.e,Mplex" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#getStreams.e%2CMplex"><span class="Identifier">getStreams</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">seq</span><span class="Other">[</span><a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/mplex/mplex.nim#L250"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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">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/message-id-mem/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#L215" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -415,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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/message-id-mem/libp2p/muxers/muxer.nim#L38"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/muxer.nim#L55"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/muxer.nim#L42"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/muxer.nim#L50"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/muxer.nim#L63"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/muxer.nim#L53"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/muxer.nim#L49"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/muxers/muxer.nim#L45"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -211,13 +211,18 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
flushed: Table[uint32, int]
|
||||
currentId: uint32
|
||||
isClosed: bool
|
||||
maxChannCount: int">Yamux</a></li>
|
||||
maxChannCount: int
|
||||
windowSize: int
|
||||
maxSendQueueSize: int
|
||||
inTimeout: Duration
|
||||
outTimeout: Duration">Yamux</a></li>
|
||||
<li><a class="reference" href="#YamuxChannel"
|
||||
title="YamuxChannel = ref object of Connection
|
||||
id: uint32
|
||||
recvWindow: int
|
||||
sendWindow: int
|
||||
maxRecvWindow: int
|
||||
maxSendQueueSize: int
|
||||
conn: Connection
|
||||
isSrc: bool
|
||||
opened: bool
|
||||
@ -226,12 +231,12 @@ 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>
|
||||
<li><a class="reference" href="#YamuxError"
|
||||
title="YamuxError = object of CatchableError">YamuxError</a></li>
|
||||
title="YamuxError = object of MuxerError">YamuxError</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
@ -240,6 +245,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#YamuxCodec"
|
||||
title="YamuxCodec = "/yamux/1.0.0"">YamuxCodec</a></li>
|
||||
<li><a class="reference" href="#YamuxDefaultWindowSize"
|
||||
title="YamuxDefaultWindowSize = 256000">YamuxDefaultWindowSize</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
@ -247,13 +254,14 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">new
|
||||
<li><a class="reference" href="#new%2Ctype%5BYamux%5D%2CConnection%2Cint"
|
||||
title="new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount): T:type">new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount): T:type</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">open
|
||||
<li><a class="reference" href="#open%2CYamuxChannel"
|
||||
title="open(channel: YamuxChannel): Future[void]">open(channel: YamuxChannel): Future[void]</a></li>
|
||||
<li><a class="reference" href="#new%2Ctype%5BYamux%5D%2CConnection%2Cint%2Cint%2Cint%2CDuration%2CDuration"
|
||||
title="new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
||||
windowSize: int = YamuxDefaultWindowSize;
|
||||
maxSendQueueSize: int = MaxSendQueueSize; inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes): T:type">new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
||||
windowSize: int = YamuxDefaultWindowSize;
|
||||
maxSendQueueSize: int = MaxSendQueueSize; inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes): T:type</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">setMaxRecvWindow
|
||||
@ -269,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
|
||||
@ -289,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>
|
||||
|
||||
@ -344,14 +358,18 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<span class="Identifier">currentId</span><span class="Other">:</span> <span class="Identifier">uint32</span>
|
||||
<span class="Identifier">isClosed</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">maxChannCount</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">windowSize</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">maxSendQueueSize</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">inTimeout</span><span class="Other">:</span> <span class="Identifier">Duration</span>
|
||||
<span class="Identifier">outTimeout</span><span class="Other">:</span> <span class="Identifier">Duration</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L359"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L359" 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>
|
||||
@ -361,6 +379,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<span class="Identifier">recvWindow</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">sendWindow</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">maxRecvWindow</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">maxSendQueueSize</span><span class="Other">:</span> <span class="Identifier">int</span>
|
||||
<span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>
|
||||
<span class="Identifier">isSrc</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">opened</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
@ -369,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>
|
||||
@ -378,21 +397,21 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L141"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L141" 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>
|
||||
<div id="YamuxError" class="tohide">
|
||||
<dt><pre><a href="yamux.html#YamuxError"><span class="Identifier">YamuxError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span></pre></dt>
|
||||
<dt><pre><a href="yamux.html#YamuxError"><span class="Identifier">YamuxError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L36"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L36" 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>
|
||||
@ -411,6 +430,18 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L23" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="YamuxDefaultWindowSize" class="tohide">
|
||||
<dt><pre><a href="yamux.html#YamuxDefaultWindowSize"><span class="Identifier">YamuxDefaultWindowSize</span></a> <span class="Other">=</span> <span class="DecNumber">256000</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L25"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
||||
@ -418,29 +449,19 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="new,type[Yamux],Connection,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctype%5BYamux%5D%2CConnection%2Cint"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">type</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">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">maxChannCount</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">MaxChannelCount</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.
|
||||
<div id="new,type[Yamux],Connection,int,int,int,Duration,Duration" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctype%5BYamux%5D%2CConnection%2Cint%2Cint%2Cint%2CDuration%2CDuration"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">type</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">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">maxChannCount</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">MaxChannelCount</span><span class="Other">;</span>
|
||||
<span class="Identifier">windowSize</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">YamuxDefaultWindowSize</span><span class="Other">;</span>
|
||||
<span class="Identifier">maxSendQueueSize</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">MaxSendQueueSize</span><span class="Other">;</span>
|
||||
<span class="Identifier">inTimeout</span><span class="Other">:</span> <span class="Identifier">Duration</span> <span class="Other">=</span> <span class="DecNumber">5</span><span class="Other">.</span><span class="Identifier">minutes</span><span class="Other">;</span> <span class="Identifier">outTimeout</span><span class="Other">:</span> <span class="Identifier">Duration</span> <span class="Other">=</span> <span class="DecNumber">5</span><span class="Other">.</span><span class="Identifier">minutes</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L524"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L524" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="open,YamuxChannel" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#open%2CYamuxChannel"><span class="Identifier">open</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L349"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L349" 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>
|
||||
@ -451,9 +472,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L273"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L273" 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>
|
||||
@ -463,30 +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">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">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%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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L406"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L406" 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">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><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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L186"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L186" class="link-seesrc" target="_blank" >Edit</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>
|
||||
@ -496,9 +516,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L508"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L508" 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>
|
||||
@ -508,64 +528,66 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L356"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L356" 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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L432"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L432" 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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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%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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L514"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L514" class="link-seesrc" target="_blank" >Edit</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">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">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">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%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/message-id-mem/libp2p/muxers/yamux/yamux.nim#L236"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L236" 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>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/muxers/yamux/yamux.nim#L333"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L333" 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>
|
||||
@ -584,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -305,7 +305,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="resolveDnsAddr,NameResolver,MultiAddress,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#resolveDnsAddr%2CNameResolver%2CMultiAddress%2Cint"><span class="Identifier">resolveDnsAddr</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="nameresolver.html#NameResolver"><span class="Identifier">NameResolver</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span> <span class="Identifier">depth</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="DecNumber">0</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><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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">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">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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>
|
||||
|
||||
@ -319,7 +319,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="resolveMAddress,NameResolver,MultiAddress" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#resolveMAddress%2CNameResolver%2CMultiAddress"><span class="Identifier">resolveMAddress</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="nameresolver.html#NameResolver"><span class="Identifier">NameResolver</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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">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">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</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>
|
||||
|
||||
@ -339,7 +339,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="resolveIp.e,NameResolver,string,Port,Domain" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#resolveIp.e%2CNameResolver%2Cstring%2CPort%2CDomain"><span class="Identifier">resolveIp</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="nameresolver.html#NameResolver"><span class="Identifier">NameResolver</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <span class="Identifier">Port</span><span class="Other">;</span>
|
||||
<span class="Identifier">domain</span><span class="Other">:</span> <span class="Identifier">Domain</span> <span class="Other">=</span> <span class="Identifier">Domain</span><span class="Other">.</span><span class="Identifier">AF_UNSPEC</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">TransportAddress</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">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">seq</span><span class="Other">[</span><span class="Identifier">TransportAddress</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">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>
|
||||
|
||||
@ -353,7 +353,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="resolveTxt.e,NameResolver,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#resolveTxt.e%2CNameResolver%2Cstring"><span class="Identifier">resolveTxt</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="nameresolver.html#NameResolver"><span class="Identifier">NameResolver</span></a><span class="Other">;</span> <span class="Identifier">address</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">seq</span><span class="Other">[</span><span class="Identifier">string</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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
@ -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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:54 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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-19 14:51:25 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:51 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -397,7 +397,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="dialPeerV1,RelayClient,Connection,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#dialPeerV1%2CRelayClient%2CConnection%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">dialPeerV1</span></a><span class="Other">(</span><span class="Identifier">cl</span><span class="Other">:</span> <a href="client.html#RelayClient"><span class="Identifier">RelayClient</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">dstPeerId</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">dstAddrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -412,7 +412,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="dialPeerV2,RelayClient,RelayConnection,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#dialPeerV2%2CRelayClient%2CRelayConnection%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">dialPeerV2</span></a><span class="Other">(</span><span class="Identifier">cl</span><span class="Other">:</span> <a href="client.html#RelayClient"><span class="Identifier">RelayClient</span></a><span class="Other">;</span> <span class="Identifier">conn</span><span class="Other">:</span> <a href="rconn.html#RelayConnection"><span class="Identifier">RelayConnection</span></a><span class="Other">;</span> <span class="Identifier">dstPeerId</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">dstAddrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -446,7 +446,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="reserve,RelayClient,PeerId,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#reserve%2CRelayClient%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">reserve</span></a><span class="Other">(</span><span class="Identifier">cl</span><span class="Other">:</span> <a href="client.html#RelayClient"><span class="Identifier">RelayClient</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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>
|
||||
<a href="client.html#Rsvp"><span class="Identifier">Rsvp</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<a href="client.html#Rsvp"><span class="Identifier">Rsvp</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>
|
||||
|
||||
@ -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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:57 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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/message-id-mem/libp2p/protocols/connectivity/relay/rconn.nim#L44"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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">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">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/message-id-mem/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">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">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/message-id-mem/libp2p/protocols/connectivity/relay/rconn.nim#L26"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/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">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">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/message-id-mem/libp2p/protocols/connectivity/relay/rconn.nim#L30"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -290,12 +290,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">start
|
||||
<li><a class="reference" href="#start.e%2CRelay"
|
||||
title="start(r: Relay): Future[void]">start(r: Relay): Future[void]</a></li>
|
||||
title="start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]">start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">stop
|
||||
<li><a class="reference" href="#stop.e%2CRelay"
|
||||
title="stop(r: Relay): Future[void]">stop(r: Relay): Future[void]</a></li>
|
||||
title="stop(r: Relay): InternalRaisesFuture[void, void]">stop(r: Relay): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -455,7 +455,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dl class="item">
|
||||
<div id="handleHop,Relay,Connection,RelayMessage" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#handleHop%2CRelay%2CConnection%2CRelayMessage"><span class="Identifier">handleHop</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</span></a><span class="Other">;</span> <span class="Identifier">connSrc</span><span class="Other">:</span> <a href="../../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="messages.html#RelayMessage"><span class="Identifier">RelayMessage</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><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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -468,8 +468,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handleHopStreamV2,Relay,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#handleHopStreamV2%2CRelay%2CConnection"><span class="Identifier">handleHopStreamV2</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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><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><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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#handleHopStreamV2%2CRelay%2CConnection"><span class="Identifier">handleHopStreamV2</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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><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>
|
||||
|
||||
@ -531,29 +531,30 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="start.e,Relay" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CRelay"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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">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">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="#start.e%2CRelay"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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><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 class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L364"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L366"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L364" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L366" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,Relay" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CRelay"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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">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">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="#stop.e%2CRelay"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</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">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L371"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L376"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L371" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L376" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -567,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -305,8 +305,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="dial,RelayTransport,MultiAddress" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#dial%2CRelayTransport%2CMultiAddress"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#dial%2CRelayTransport%2CMultiAddress"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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>
|
||||
|
||||
@ -337,9 +337,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="accept.e,RelayTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#accept.e%2CRelayTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
</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">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">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="#accept.e%2CRelayTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><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>
|
||||
|
||||
|
||||
@ -353,7 +352,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="dial.e,RelayTransport,string,MultiAddress,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CRelayTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">hostname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">Opt</span><span class="Other">.</span><span class="Identifier">none</span><span class="Other">(</span><span class="Identifier">PeerId</span><span class="Other">)</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -380,7 +379,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="start.e,RelayTransport,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CRelayTransport%2Cseq%5BMultiAddress%5D"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -393,8 +392,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,RelayTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CRelayTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</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><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">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">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="#stop.e%2CRelayTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="rtransport.html#RelayTransport"><span class="Identifier">RelayTransport</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>
|
||||
|
||||
|
||||
@ -415,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:57 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -219,22 +219,30 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">bridge
|
||||
<li><a class="reference" href="#bridge%2CConnection%2CConnection"
|
||||
title="bridge(connSrc: Connection; connDst: Connection): Future[void]">bridge(connSrc: Connection; connDst: Connection): Future[void]</a></li>
|
||||
title="bridge(connSrc: Connection; connDst: Connection): InternalRaisesFuture[void,
|
||||
(CancelledError,)]">bridge(connSrc: Connection; connDst: Connection): InternalRaisesFuture[void,
|
||||
(CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">sendHopStatus
|
||||
<li><a class="reference" href="#sendHopStatus%2CConnection%2CStatusV2"
|
||||
title="sendHopStatus(conn: Connection; code: StatusV2): Future[void]">sendHopStatus(conn: Connection; code: StatusV2): Future[void]</a></li>
|
||||
title="sendHopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">sendHopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">sendStatus
|
||||
<li><a class="reference" href="#sendStatus%2CConnection%2CStatusV1"
|
||||
title="sendStatus(conn: Connection; code: StatusV1): Future[void]">sendStatus(conn: Connection; code: StatusV1): Future[void]</a></li>
|
||||
title="sendStatus(conn: Connection; code: StatusV1): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">sendStatus(conn: Connection; code: StatusV1): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">sendStopStatus
|
||||
<li><a class="reference" href="#sendStopStatus%2CConnection%2CStatusV2"
|
||||
title="sendStopStatus(conn: Connection; code: StatusV2): Future[void]">sendStopStatus(conn: Connection; code: StatusV2): Future[void]</a></li>
|
||||
title="sendStopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]">sendStopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -303,51 +311,23 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="bridge,Connection,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#bridge%2CConnection%2CConnection"><span class="Identifier">bridge</span></a><span class="Other">(</span><span class="Identifier">connSrc</span><span class="Other">:</span> <a href="../../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">connDst</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 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">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">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="#bridge%2CConnection%2CConnection"><span class="Identifier">bridge</span></a><span class="Other">(</span><span class="Identifier">connSrc</span><span class="Other">:</span> <a href="../../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">connDst</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>
|
||||
<span class="Identifier">void</span><span class="Other">,</span> <span class="Other">(</span><span class="Identifier">CancelledError</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">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/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L45"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L57"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="sendHopStatus,Connection,StatusV2" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendHopStatus%2CConnection%2CStatusV2"><span class="Identifier">sendHopStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV2"><span class="Identifier">StatusV2</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><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">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">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/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L31"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="sendStatus,Connection,StatusV1" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendStatus%2CConnection%2CStatusV1"><span class="Identifier">sendStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV1"><span class="Identifier">StatusV1</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><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">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">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/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L24"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="sendStopStatus,Connection,StatusV2" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendStopStatus%2CConnection%2CStatusV2"><span class="Identifier">sendStopStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV2"><span class="Identifier">StatusV2</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">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">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="#sendHopStatus%2CConnection%2CStatusV2"><span class="Identifier">sendHopStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV2"><span class="Identifier">StatusV2</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="../../../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>
|
||||
|
||||
|
||||
@ -356,6 +336,34 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protoco
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="sendStatus,Connection,StatusV1" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendStatus%2CConnection%2CStatusV1"><span class="Identifier">sendStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV1"><span class="Identifier">StatusV1</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="../../../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/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L27"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="sendStopStatus,Connection,StatusV2" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendStopStatus%2CConnection%2CStatusV2"><span class="Identifier">sendStopStatus</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">code</span><span class="Other">:</span> <a href="messages.html#StatusV2"><span class="Identifier">StatusV2</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="../../../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/message-id-mem/libp2p/protocols/connectivity/relay/utils.nim#L48"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/utils.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
||||
@ -368,7 +376,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -273,7 +273,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">new
|
||||
<li><a class="reference" href="#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo"
|
||||
title="new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type">new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type</a></li>
|
||||
title="new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false;
|
||||
observedAddrManager = ObservedAddrManager.new()): T:type">new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false;
|
||||
observedAddrManager = ObservedAddrManager.new()): T:type</a></li>
|
||||
<li><a class="reference" href="#new%2Ctypedesc%5BIdentifyPush%5D%2CIdentifyPushHandler"
|
||||
title="new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type">new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type</a></li>
|
||||
|
||||
@ -330,7 +332,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="../protobuf/minprotobuf.html">../protobuf/minprotobuf</a>, <a class="reference external" href="../peerinfo.html">../peerinfo</a>, <a class="reference external" href="../stream/connection.html">../stream/connection</a>, <a class="reference external" href="../peerid.html">../peerid</a>, <a class="reference external" href="../crypto/crypto.html">../crypto/crypto</a>, <a class="reference external" href="../multiaddress.html">../multiaddress</a>, <a class="reference external" href="protocol.html">protocol</a>, <a class="reference external" href="../utility.html">../utility</a>, <a class="reference external" href="../errors.html">../errors</a>, <a class="reference external" href="../observedaddrmanager.html">../observedaddrmanager</a>
|
||||
<a class="reference external" href="../protobuf/minprotobuf.html">../protobuf/minprotobuf</a>, <a class="reference external" href="../peerinfo.html">../peerinfo</a>, <a class="reference external" href="../stream/connection.html">../stream/connection</a>, <a class="reference external" href="../peerid.html">../peerid</a>, <a class="reference external" href="../crypto/crypto.html">../crypto/crypto</a>, <a class="reference external" href="../multiaddress.html">../multiaddress</a>, <a class="reference external" href="../multicodec.html">../multicodec</a>, <a class="reference external" href="protocol.html">protocol</a>, <a class="reference external" href="../utility.html">../utility</a>, <a class="reference external" href="../errors.html">../errors</a>, <a class="reference external" href="../observedaddrmanager.html">../observedaddrmanager</a>
|
||||
</dl></div>
|
||||
<div class="section" id="7">
|
||||
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
||||
@ -345,9 +347,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L56"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L57"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -357,9 +359,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L41"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L42"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -378,9 +380,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L46"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L47"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -390,9 +392,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L44"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L45"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -404,9 +406,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L67"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L68"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -417,9 +419,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L61"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L62"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -429,9 +431,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L43"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L44"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L44" 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/message-id-mem/libp2p/protocols/identify.nim#L42"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L43"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -458,9 +460,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L38"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L39"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -469,18 +471,6 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L35"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="IdentifyPushCodec" class="tohide">
|
||||
<dt><pre><a href="identify.html#IdentifyPushCodec"><span class="Identifier">IdentifyPushCodec</span></a> <span class="Other">=</span> <span class="StringLit">"/ipfs/id/push/1.0.0"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L36"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
@ -488,8 +478,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="ProtoVersion" class="tohide">
|
||||
<dt><pre><a href="identify.html#ProtoVersion"><span class="Identifier">ProtoVersion</span></a> <span class="Other">=</span> <span class="StringLit">"ipfs/0.1.0"</span></pre></dt>
|
||||
<div id="IdentifyPushCodec" class="tohide">
|
||||
<dt><pre><a href="identify.html#IdentifyPushCodec"><span class="Identifier">IdentifyPushCodec</span></a> <span class="Other">=</span> <span class="StringLit">"/ipfs/id/push/1.0.0"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -498,6 +488,18 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protoco
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="ProtoVersion" class="tohide">
|
||||
<dt><pre><a href="identify.html#ProtoVersion"><span class="Identifier">ProtoVersion</span></a> <span class="Other">=</span> <span class="StringLit">"ipfs/0.1.0"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L38"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
|
||||
@ -512,23 +514,23 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L112"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L113"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L112" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="identify,Identify,Connection,PeerId" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#identify%2CIdentify%2CConnection%2CPeerId"><span class="Identifier">identify</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="identify.html#Identify"><span class="Identifier">Identify</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">remotePeerId</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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>
|
||||
<a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</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/message-id-mem/libp2p/protocols/identify.nim#L171"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L172"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L171" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L172" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -538,15 +540,16 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L200"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L206"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L200" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L206" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="new,typedesc[Identify],PeerInfo" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="identify.html#Identify"><span class="Identifier">Identify</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">peerInfo</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a><span class="Other">;</span> <span class="Identifier">sendSignedPeerRecord</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</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>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="identify.html#Identify"><span class="Identifier">Identify</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">peerInfo</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">sendSignedPeerRecord</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span>
|
||||
<span class="Identifier">observedAddrManager</span> <span class="Other">=</span> <a href="../observedaddrmanager.html#ObservedAddrManager"><span class="Identifier">ObservedAddrManager</span></a><span class="Other">.</span><span class="Identifier">new</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -564,23 +567,23 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Create a IdentifyPush protocol. <tt class="docutils literal"><span class="pre"><span class="Identifier">handler</span></span></tt> will be called every time a peer sends us new <tt class="docutils literal"><span class="pre"><span class="Identifier">PeerInfo</span></span></tt>
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L193"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L199"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L193" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L199" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="push,IdentifyPush,PeerInfo,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#push%2CIdentifyPush%2CPeerInfo%2CConnection"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="identify.html#IdentifyPush"><span class="Identifier">IdentifyPush</span></a><span class="Other">;</span> <span class="Identifier">peerInfo</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</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><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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
Send new <tt class="docutils literal"><span class="pre"><span class="Identifier">peerInfo</span></span></tt>s to a connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L229"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L236"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L229" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -595,9 +598,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L152"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L153"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L152" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -612,9 +615,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L70"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/identify.nim#L71"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -633,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -268,12 +268,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">start
|
||||
<li><a class="reference" href="#start.e%2CLPProtocol"
|
||||
title="start(p: LPProtocol): Future[void]">start(p: LPProtocol): Future[void]</a></li>
|
||||
title="start(p: LPProtocol): InternalRaisesFuture[void, (CancelledError,)]">start(p: LPProtocol): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">stop
|
||||
<li><a class="reference" href="#stop.e%2CLPProtocol"
|
||||
title="stop(p: LPProtocol): Future[void]">stop(p: LPProtocol): Future[void]</a></li>
|
||||
title="stop(p: LPProtocol): InternalRaisesFuture[void, void]">stop(p: LPProtocol): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -358,9 +358,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L43"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L54"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -370,9 +370,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L47"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L58"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -382,9 +382,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L37"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L48"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -394,9 +394,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L40"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L51"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -408,9 +408,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L52"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L63"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L52" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -432,28 +432,29 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start.e,LPProtocol" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CLPProtocol"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</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">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">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="#start.e%2CLPProtocol"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</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><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/message-id-mem/libp2p/protocols/protocol.nim#L34"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L36"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,LPProtocol" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CLPProtocol"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</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">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">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="#stop.e%2CLPProtocol"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</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="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L35"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/protocol.nim#L42"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/protocol.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -467,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -436,7 +436,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="publish.e,FloodSub,string,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#publish.e%2CFloodSub%2Cstring%2Cseq%5Bbyte%5D"><span class="Identifier">publish</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="floodsub.html#FloodSub"><span class="Identifier">FloodSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><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">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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -450,7 +450,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="rpcHandler.e,FloodSub,PubSubPeer,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#rpcHandler.e%2CFloodSub%2CPubSubPeer%2Cseq%5Bbyte%5D"><span class="Identifier">rpcHandler</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="floodsub.html#FloodSub"><span class="Identifier">FloodSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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">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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -485,7 +485,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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -422,8 +422,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="heartbeat,GossipSub" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#heartbeat%2CGossipSub"><span class="Identifier">heartbeat</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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">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">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="#heartbeat%2CGossipSub"><span class="Identifier">heartbeat</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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>
|
||||
|
||||
|
||||
@ -462,7 +462,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="rebalanceMesh,GossipSub,string,ptr.MeshMetrics" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#rebalanceMesh%2CGossipSub%2Cstring%2Cptr.MeshMetrics"><span class="Identifier">rebalanceMesh</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">metrics</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="types.html#MeshMetrics"><span class="Identifier">MeshMetrics</span></a> <span class="Other">=</span> <span class="Keyword">nil</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">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>
|
||||
<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">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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -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-19 14:51:31 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -347,7 +347,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="disconnectPeer,GossipSub,PubSubPeer" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#disconnectPeer%2CGossipSub%2CPubSubPeer"><span class="Identifier">disconnectPeer</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="../pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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">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>
|
||||
<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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -372,7 +372,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="punishInvalidMessage,GossipSub,PubSubPeer,Message" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#punishInvalidMessage%2CGossipSub%2CPubSubPeer%2CMessage"><span class="Identifier">punishInvalidMessage</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="../pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="../rpc/messages.html#Message"><span class="Identifier">Message</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">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>
|
||||
<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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -398,8 +398,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="scoringHeartbeat,GossipSub" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#scoringHeartbeat%2CGossipSub"><span class="Identifier">scoringHeartbeat</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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">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="#scoringHeartbeat%2CGossipSub"><span class="Identifier">scoringHeartbeat</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -301,8 +301,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">broadcast
|
||||
<li><a class="reference" href="#broadcast%2CPubSub%2Cauto%2CRPCMsg"
|
||||
title="broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg)">broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg)</a></li>
|
||||
<li><a class="reference" href="#broadcast%2CPubSub%2Cauto%2CRPCMsg%2Cbool"
|
||||
title="broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg; isHighPriority: bool)">broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg; isHighPriority: bool)</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">handleData
|
||||
@ -335,8 +335,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">send
|
||||
<li><a class="reference" href="#send%2CPubSub%2CPubSubPeer%2CRPCMsg"
|
||||
title="send(p: PubSub; peer: PubSubPeer; msg: RPCMsg)">send(p: PubSub; peer: PubSubPeer; msg: RPCMsg)</a></li>
|
||||
<li><a class="reference" href="#send%2CPubSub%2CPubSubPeer%2CRPCMsg%2Cbool"
|
||||
title="send(p: PubSub; peer: PubSubPeer; msg: RPCMsg; isHighPriority: bool)">send(p: PubSub; peer: PubSubPeer; msg: RPCMsg; isHighPriority: bool)</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">sendSubs
|
||||
@ -810,21 +810,30 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L602"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L618"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L602" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L618" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="broadcast,PubSub,auto,RPCMsg" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#broadcast%2CPubSub%2Cauto%2CRPCMsg"><span class="Identifier">broadcast</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">sendPeers</span><span class="Other">:</span> <span class="Identifier">auto</span><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<div id="broadcast,PubSub,auto,RPCMsg,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#broadcast%2CPubSub%2Cauto%2CRPCMsg%2Cbool"><span class="Identifier">broadcast</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">sendPeers</span><span class="Other">:</span> <span class="Identifier">auto</span><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><span class="Other">;</span> <span class="Identifier">isHighPriority</span><span class="Other">:</span> <span class="Identifier">bool</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Attempt to send <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> to the given peers
|
||||
<p>This procedure attempts to send a <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> (of type <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt>) to a specified group of peers in the PubSub network.</p>
|
||||
<p>Parameters:</p>
|
||||
<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSub</span></span></tt> instance.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">sendPeers</span></span></tt>: An iterable of <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt> instances representing the peers to whom the message should be sent.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt> instance that contains the message to be broadcast.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">isHighPriority</span></span></tt>: A boolean indicating whether the message should be treated as high priority.</li>
|
||||
</ul>
|
||||
<p>High priority messages are sent immediately, while low priority messages are queued and sent only after all high priority messages have been sent.</p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L148"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L155"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L148" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -835,9 +844,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L310"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L326"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L310" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L326" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -856,9 +865,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L547"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L563"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L547" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L563" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -869,18 +878,26 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L604"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L620"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L604" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L620" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="send,PubSub,PubSubPeer,RPCMsg" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#send%2CPubSub%2CPubSubPeer%2CRPCMsg"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><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">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="send,PubSub,PubSubPeer,RPCMsg,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#send%2CPubSub%2CPubSubPeer%2CRPCMsg%2Cbool"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><span class="Other">;</span> <span class="Identifier">isHighPriority</span><span class="Other">:</span> <span class="Identifier">bool</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">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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Attempt to send <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> to remote peer
|
||||
<p>This procedure attempts to send a <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> (of type <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt>) to the specified remote peer in the PubSub network.</p>
|
||||
<p>Parameters:</p>
|
||||
<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSub</span></span></tt> instance.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">peer</span></span></tt>: An instance of <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt> representing the peer to whom the message should be sent.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt> instance that contains the message to be sent.</li>
|
||||
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">isHighPriority</span></span></tt>: A boolean indicating whether the message should be treated as high priority.</li>
|
||||
</ul>
|
||||
<p>High priority messages are sent immediately, while low priority messages are queued and sent only after all high priority messages have been sent.</p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L141"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
@ -890,14 +907,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="sendSubs,PubSub,PubSubPeer,openArray[string],bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sendSubs%2CPubSub%2CPubSubPeer%2CopenArray%5Bstring%5D%2Cbool"><span class="Identifier">sendSubs</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">topics</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span>
|
||||
<span class="Identifier">subscribe</span><span class="Other">:</span> <span class="Identifier">bool</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>
|
||||
<span class="Identifier">subscribe</span><span class="Other">:</span> <span class="Identifier">bool</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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
send subscriptions to remote peer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L205"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L221"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L221" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -913,35 +931,35 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dl>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L448"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L464"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L448" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L464" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="unsubscribe,PubSub,string,TopicHandler" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#unsubscribe%2CPubSub%2Cstring%2CTopicHandler"><span class="Identifier">unsubscribe</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">handler</span><span class="Other">:</span> <a href="pubsub.html#TopicHandler"><span class="Identifier">TopicHandler</span></a><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">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>
|
||||
<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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
unsubscribe from a <tt class="docutils literal"><span class="pre">topic</span></tt> string
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L417"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L433"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L417" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L433" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="unsubscribe,PubSub,openArray[TopicPair]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#unsubscribe%2CPubSub%2CopenArray%5BTopicPair%5D"><span class="Identifier">unsubscribe</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">topics</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><a href="pubsub.html#TopicPair"><span class="Identifier">TopicPair</span></a><span class="Other">]</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">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>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</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>
|
||||
|
||||
unsubscribe from a list of <tt class="docutils literal"><span class="pre">topic</span></tt> handlers
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L432"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L448"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L432" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L448" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -952,9 +970,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
unsubscribe every <tt class="docutils literal"><span class="pre"><span class="Identifier">handler</span></span></tt> from <tt class="docutils literal"><span class="pre"><span class="Identifier">topic</span></span></tt>
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L437"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L453"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L437" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L453" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -964,9 +982,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L224"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L240"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L224" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L240" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -982,28 +1000,28 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
Add a validator to a <tt class="docutils literal"><span class="pre"><span class="Identifier">topic</span></span></tt>. Each new message received in this will be sent to <tt class="docutils literal"><span class="pre"><span class="Identifier">hook</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">hook</span></span></tt> can return either <tt class="docutils literal"><span class="pre"><span class="Identifier">Accept</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">Ignore</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">Reject</span></span></tt> (which can descore the peer)
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L497"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L513"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L497" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L513" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="getOrCreatePeer.e,PubSub,PeerId,seq[string]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#getOrCreatePeer.e%2CPubSub%2CPeerId%2Cseq%5Bstring%5D"><span class="Identifier">getOrCreatePeer</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a> {.
|
||||
<span class="Identifier">base</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="Identifier">RootEffect</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>
|
||||
<span class="Identifier">base</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="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L282"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L298"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L282" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L298" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handleConn.e,PubSub,Connection,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handleConn.e%2CPubSub%2CConnection%2Cstring"><span class="Identifier">handleConn</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</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">proto</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">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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
@ -1015,9 +1033,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</ol>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L347"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L363"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L347" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L363" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -1028,41 +1046,41 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
perform pubsub initialization
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L490"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L506"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L490" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L506" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="onPubSubPeerEvent.e,PubSub,PubSubPeer,PubSubPeerEvent" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#onPubSubPeerEvent.e%2CPubSub%2CPubSubPeer%2CPubSubPeerEvent"><span class="Identifier">onPubSubPeerEvent</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">event</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeerEvent"><span class="Identifier">PubSubPeerEvent</span></a><span class="Other">)</span> {.
|
||||
<span class="Identifier">base</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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<span class="Identifier">base</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="Identifier">RootEffect</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/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L273"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L289"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L273" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L289" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="onTopicSubscription.e,PubSub,string,bool" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#onTopicSubscription.e%2CPubSub%2Cstring%2Cbool"><span class="Identifier">onTopicSubscription</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">subscribed</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span> {.<span class="Identifier">base</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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<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="Identifier">RootEffect</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/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L400"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L416"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L400" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L416" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="publish.e,PubSub,string,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#publish.e%2CPubSub%2Cstring%2Cseq%5Bbyte%5D"><span class="Identifier">publish</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><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">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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
@ -1070,9 +1088,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<p>The return value is the number of neighbours that we attempted to send the message to, excluding self. Note that this is an optimistic number of attempts - the number of peers that actually receive the message might be lower.</p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L478"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L494"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L478" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L494" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -1083,36 +1101,36 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L507"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L523"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L507" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L523" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="rpcHandler.e,PubSub,PubSubPeer,seq[byte]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#rpcHandler.e%2CPubSub%2CPubSubPeer%2Cseq%5Bbyte%5D"><span class="Identifier">rpcHandler</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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">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">raises</span><span class="Other">:</span> <span class="Other">[</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">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>
|
||||
|
||||
Handler that must be overridden by concrete implementation
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L267"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L283"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L267" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L283" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="subscribePeer.e,PubSub,PeerId" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#subscribePeer.e%2CPubSub%2CPeerId"><span class="Identifier">subscribePeer</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">)</span> {.<span class="Identifier">base</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="Identifier">RootEffect</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>
|
||||
<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 class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
subscribe to remote peer to receive/send pubsub messages
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L376"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L392"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L376" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L392" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -1131,15 +1149,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="validate.e,PubSub,Message" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#validate.e%2CPubSub%2CMessage"><span class="Identifier">validate</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <a href="rpc/messages.html#Message"><span class="Identifier">Message</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="errors.html#ValidationResult"><span class="Identifier">ValidationResult</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">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">raises</span><span class="Other">:</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">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/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L516"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/pubsub/pubsub.nim#L532"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L516" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsub.nim#L532" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -1158,7 +1176,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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -662,7 +662,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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -456,7 +456,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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -284,12 +284,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">start
|
||||
<li><a class="reference" href="#start.e%2CRendezVous"
|
||||
title="start(rdv: RendezVous): Future[void]">start(rdv: RendezVous): Future[void]</a></li>
|
||||
title="start(rdv: RendezVous): InternalRaisesFuture[void, (CancelledError,)]">start(rdv: RendezVous): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">stop
|
||||
<li><a class="reference" href="#stop.e%2CRendezVous"
|
||||
title="stop(rdv: RendezVous): Future[void]">stop(rdv: RendezVous): Future[void]</a></li>
|
||||
title="stop(rdv: RendezVous): InternalRaisesFuture[void, void]">stop(rdv: RendezVous): InternalRaisesFuture[void, void]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -413,7 +413,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="request,RendezVous,string,int" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#request%2CRendezVous%2Cstring%2Cint"><span class="Identifier">request</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</span></a><span class="Other">;</span> <span class="Identifier">ns</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">l</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="DecNumber">1000'u64</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><a href="../routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</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">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">seq</span><span class="Other">[</span><a href="../routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</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>
|
||||
|
||||
@ -452,7 +452,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</div>
|
||||
<div id="unsubscribe,RendezVous,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#unsubscribe%2CRendezVous%2Cstring"><span class="Identifier">unsubscribe</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</span></a><span class="Other">;</span> <span class="Identifier">ns</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">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">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">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>
|
||||
<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>
|
||||
|
||||
|
||||
@ -482,7 +482,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dl class="item">
|
||||
<div id="advertise.e,RendezVous,string,Duration" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#advertise.e%2CRendezVous%2Cstring%2CDuration"><span class="Identifier">advertise</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</span></a><span class="Other">;</span> <span class="Identifier">ns</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">ttl</span><span class="Other">:</span> <span class="Identifier">Duration</span> <span class="Other">=</span> <span class="Identifier">MinimumDuration</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</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>
|
||||
|
||||
@ -495,28 +495,30 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start.e,RendezVous" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CRendezVous"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</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">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">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="#start.e%2CRendezVous"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</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><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 class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/rendezvous.nim#L681"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/rendezvous.nim#L683"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/rendezvous.nim#L681" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/rendezvous.nim#L683" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,RendezVous" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CRendezVous"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</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">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">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="#stop.e%2CRendezVous"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">rdv</span><span class="Other">:</span> <a href="rendezvous.html#RendezVous"><span class="Identifier">RendezVous</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">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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/message-id-mem/libp2p/protocols/rendezvous.nim#L688"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/rendezvous.nim#L693"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/rendezvous.nim#L688" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/rendezvous.nim#L693" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -530,7 +532,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -220,7 +220,7 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li><a class="reference" href="#NoiseDecryptTagError"
|
||||
title="NoiseDecryptTagError = object of NoiseError">NoiseDecryptTagError</a></li>
|
||||
<li><a class="reference" href="#NoiseError"
|
||||
title="NoiseError = object of LPError">NoiseError</a></li>
|
||||
title="NoiseError = object of LPStreamError">NoiseError</a></li>
|
||||
<li><a class="reference" href="#NoiseHandshakeError"
|
||||
title="NoiseHandshakeError = object of NoiseError">NoiseHandshakeError</a></li>
|
||||
<li><a class="reference" href="#NoiseNonceMaxError"
|
||||
@ -261,14 +261,14 @@ 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
|
||||
<li><a class="reference" href="#handshake.e%2CNoise%2CConnection%2Cbool%2COpt%5BPeerId%5D"
|
||||
title="handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]">handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]</a></li>
|
||||
title="handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]">handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">init
|
||||
@ -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>
|
||||
|
||||
@ -368,7 +372,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="NoiseError" class="tohide">
|
||||
<dt><pre><a href="noise.html#NoiseError"><span class="Identifier">NoiseError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../../errors.html#LPError"><span class="Identifier">LPError</span></a></pre></dt>
|
||||
<dt><pre><a href="noise.html#NoiseError"><span class="Identifier">NoiseError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -445,9 +449,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L599"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L646"
|
||||
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#L646" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -469,29 +473,32 @@ 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">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">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/message-id-mem/libp2p/protocols/secure/noise.nim#L589"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L636"
|
||||
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#L636" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handshake.e,Noise,Connection,bool,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handshake.e%2CNoise%2CConnection%2Cbool%2COpt%5BPeerId%5D"><span class="Identifier">handshake</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="noise.html#Noise"><span class="Identifier">Noise</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">initiator</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="secure.html#SecureConn"><span class="Identifier">SecureConn</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">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">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>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</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">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/message-id-mem/libp2p/protocols/secure/noise.nim#L504"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L539"
|
||||
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#L539" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -501,36 +508,38 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L595"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L642"
|
||||
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#L642" 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">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">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/message-id-mem/libp2p/protocols/secure/noise.nim#L429"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L454"
|
||||
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#L454" 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 class="Identifier">RootEffect</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/message-id-mem/libp2p/protocols/secure/noise.nim#L461"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/noise.nim#L489"
|
||||
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#L489" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -561,7 +570,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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
|
||||
@ -257,9 +257,9 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">handshake
|
||||
<li><a class="reference" href="#handshake.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D"
|
||||
title="handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]">handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]</a></li>
|
||||
title="handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]">handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">init
|
||||
@ -274,19 +274,23 @@ 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
|
||||
<li><a class="reference" href="#secure.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D"
|
||||
title="secure(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
Connection]">secure(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
Connection]</a></li>
|
||||
<li><a class="reference" href="#secure.e%2CSecure%2CConnection%2COpt%5BPeerId%5D"
|
||||
title="secure(s: Secure; conn: Connection; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError)]">secure(s: Secure; conn: Connection; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError)]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -412,15 +416,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">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">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/message-id-mem/libp2p/protocols/secure/secure.nim#L66"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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>
|
||||
@ -429,6 +434,62 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L80" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handshake.e,Secure,Connection,bool,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handshake.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D"><span class="Identifier">handshake</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</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">initiator</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">InternalRaisesFuture</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">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/message-id-mem/libp2p/protocols/secure/secure.nim#L87"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="init.e,Secure" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CSecure"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</span></a><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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L134"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="initStream.e,SecureConn" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CSecureConn"><span class="Identifier">initStream</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><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="Identifier">TimeEffect</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/message-id-mem/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#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">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/message-id-mem/libp2p/protocols/secure/secure.nim#L76"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
@ -436,84 +497,32 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="handshake.e,Secure,Connection,bool,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#handshake.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D"><span class="Identifier">handshake</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</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">initiator</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="secure.html#SecureConn"><span class="Identifier">SecureConn</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">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">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>
|
||||
<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">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/message-id-mem/libp2p/protocols/secure/secure.nim#L81"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L166"
|
||||
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#L166" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="init.e,Secure" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CSecure"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</span></a><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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L116"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="initStream.e,SecureConn" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CSecureConn"><span class="Identifier">initStream</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><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="Identifier">RootEffect</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/message-id-mem/libp2p/protocols/secure/secure.nim#L60"
|
||||
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>
|
||||
|
||||
</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">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">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>
|
||||
<div id="secure.e,Secure,Connection,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#secure.e%2CSecure%2CConnection%2COpt%5BPeerId%5D"><span class="Identifier">secure</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</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">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</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><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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L73"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L158"
|
||||
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>
|
||||
|
||||
</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">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">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/message-id-mem/libp2p/protocols/secure/secure.nim#L146"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L146" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="secure.e,Secure,Connection,bool,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#secure.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D"><span class="Identifier">secure</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="secure.html#Secure"><span class="Identifier">Secure</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">initiator</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</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><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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/secure/secure.nim#L136"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L136" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/secure/secure.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -549,7 +558,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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/message-id-mem/libp2p/stream/chronosstream.nim#L59"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/stream/chronosstream.nim#L40"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/stream/chronosstream.nim#L145"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/stream/chronosstream.nim#L142"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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">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">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/message-id-mem/libp2p/stream/chronosstream.nim#L148"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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,48 +430,50 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/chronosstream.nim#L168"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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>
|
||||
<div id="initStream.e,ChronosStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CChronosStream"><span class="Identifier">initStream</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><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 class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CChronosStream"><span class="Identifier">initStream</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><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">TimeEffect</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/message-id-mem/libp2p/stream/chronosstream.nim#L49"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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">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">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/message-id-mem/libp2p/stream/chronosstream.nim#L97"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/stream/chronosstream.nim#L127"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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/message-id-mem/libp2p/stream/chronosstream.nim#L47"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -229,20 +229,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
title="LPStreamError = object of LPError">LPStreamError</a></li>
|
||||
<li><a class="reference" href="#LPStreamIncompleteError"
|
||||
title="LPStreamIncompleteError = object of LPStreamError">LPStreamIncompleteError</a></li>
|
||||
<li><a class="reference" href="#LPStreamIncorrectDefect"
|
||||
title="LPStreamIncorrectDefect = object of Defect">LPStreamIncorrectDefect</a></li>
|
||||
<li><a class="reference" href="#LPStreamLimitError"
|
||||
title="LPStreamLimitError = object of LPStreamError">LPStreamLimitError</a></li>
|
||||
<li><a class="reference" href="#LPStreamReadError"
|
||||
title="LPStreamReadError = object of LPStreamError
|
||||
par*: ref CatchableError">LPStreamReadError</a></li>
|
||||
<li><a class="reference" href="#LPStreamRemoteClosedError"
|
||||
title="LPStreamRemoteClosedError = object of LPStreamEOFError">LPStreamRemoteClosedError</a></li>
|
||||
<li><a class="reference" href="#LPStreamResetError"
|
||||
title="LPStreamResetError = object of LPStreamEOFError">LPStreamResetError</a></li>
|
||||
<li><a class="reference" href="#LPStreamWriteError"
|
||||
title="LPStreamWriteError = object of LPStreamError
|
||||
par*: ref CatchableError">LPStreamWriteError</a></li>
|
||||
<li><a class="reference" href="#MaxSizeError"
|
||||
title="MaxSizeError = object of LPStreamError">MaxSizeError</a></li>
|
||||
<li><a class="reference" href="#StreamTracker"
|
||||
@ -267,12 +259,12 @@ 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
|
||||
<li><a class="reference" href="#join%2CLPStream"
|
||||
title="join(s: LPStream): Future[void]">join(s: LPStream): Future[void]</a></li>
|
||||
title="join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]">join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamClosedError
|
||||
@ -294,23 +286,11 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li><a class="reference" href="#newLPStreamIncompleteError"
|
||||
title="newLPStreamIncompleteError(): ref LPStreamIncompleteError">newLPStreamIncompleteError(): ref LPStreamIncompleteError</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamIncorrectDefect
|
||||
<li><a class="reference" href="#newLPStreamIncorrectDefect%2Cstring"
|
||||
title="newLPStreamIncorrectDefect(m: string): ref LPStreamIncorrectDefect">newLPStreamIncorrectDefect(m: string): ref LPStreamIncorrectDefect</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamLimitError
|
||||
<li><a class="reference" href="#newLPStreamLimitError"
|
||||
title="newLPStreamLimitError(): ref LPStreamLimitError">newLPStreamLimitError(): ref LPStreamLimitError</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamReadError
|
||||
<li><a class="reference" href="#newLPStreamReadError%2Cstring"
|
||||
title="newLPStreamReadError(msg: string): ref LPStreamReadError">newLPStreamReadError(msg: string): ref LPStreamReadError</a></li>
|
||||
<li><a class="reference" href="#newLPStreamReadError%2Cref.CatchableError"
|
||||
title="newLPStreamReadError(p: ref CatchableError): ref LPStreamReadError">newLPStreamReadError(p: ref CatchableError): ref LPStreamReadError</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamRemoteClosedError
|
||||
<li><a class="reference" href="#newLPStreamRemoteClosedError"
|
||||
@ -321,35 +301,33 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li><a class="reference" href="#newLPStreamResetError"
|
||||
title="newLPStreamResetError(): ref LPStreamResetError">newLPStreamResetError(): ref LPStreamResetError</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">newLPStreamWriteError
|
||||
<li><a class="reference" href="#newLPStreamWriteError%2Cref.CatchableError"
|
||||
title="newLPStreamWriteError(p: ref CatchableError): ref LPStreamWriteError">newLPStreamWriteError(p: ref CatchableError): ref LPStreamWriteError</a></li>
|
||||
|
||||
</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>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">setupStreamTracker
|
||||
<li><a class="reference" href="#setupStreamTracker%2Cstring"
|
||||
title="setupStreamTracker(name: string): StreamTracker">setupStreamTracker(name: string): StreamTracker</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
|
||||
@ -359,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>
|
||||
|
||||
@ -382,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
|
||||
@ -392,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
|
||||
@ -402,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>
|
||||
|
||||
@ -470,9 +458,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L73"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L68"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -502,9 +490,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L69"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L64"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -514,9 +502,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L71"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L66"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -526,9 +514,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L59"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L54"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -556,8 +544,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="LPStreamIncorrectDefect" class="tohide">
|
||||
<dt><pre><a href="lpstream.html#LPStreamIncorrectDefect"><span class="Identifier">LPStreamIncorrectDefect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">Defect</span></pre></dt>
|
||||
<div id="LPStreamLimitError" class="tohide">
|
||||
<dt><pre><a href="lpstream.html#LPStreamLimitError"><span class="Identifier">LPStreamLimitError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -566,32 +554,6 @@ href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="LPStreamLimitError" class="tohide">
|
||||
<dt><pre><a href="lpstream.html#LPStreamLimitError"><span class="Identifier">LPStreamLimitError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L54"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="LPStreamReadError" class="tohide">
|
||||
<dt><pre><a href="lpstream.html#LPStreamReadError"><span class="Identifier">LPStreamReadError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a>
|
||||
<span class="Identifier">par</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">CatchableError</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L55"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="LPStreamRemoteClosedError" class="tohide">
|
||||
@ -600,9 +562,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L70"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L65"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -612,23 +574,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L68"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L63"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="LPStreamWriteError" class="tohide">
|
||||
<dt><pre><a href="lpstream.html#LPStreamWriteError"><span class="Identifier">LPStreamWriteError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a>
|
||||
<span class="Identifier">par</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">CatchableError</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L57"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -638,9 +586,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L74"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L69"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L74" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -653,9 +601,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L76"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L71"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -694,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">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">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>
|
||||
@ -704,65 +652,15 @@ 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/message-id-mem/libp2p/stream/lpstream.nim#L323"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L323" 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>
|
||||
<div id="join,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#join%2CLPStream"><span class="Identifier">join</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><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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Wait for the stream to be closed
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L163"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L163" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamClosedError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamClosedError"><span class="Identifier">newLPStreamClosedError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamClosedError"><span class="Identifier">LPStreamClosedError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L134"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamConnDownError,ref.Exception" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamConnDownError%2Cref.Exception"><span class="Identifier">newLPStreamConnDownError</span></a><span class="Other">(</span><span class="Identifier">parentException</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">Exception</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamConnDownError"><span class="Identifier">LPStreamConnDownError</span></a> {.
|
||||
<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L140"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L140" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamEOFError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamEOFError"><span class="Identifier">newLPStreamEOFError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamEOFError"><span class="Identifier">LPStreamEOFError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L128"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L128" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamIncompleteError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamIncompleteError"><span class="Identifier">newLPStreamIncompleteError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamIncompleteError"><span class="Identifier">LPStreamIncompleteError</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#join%2CLPStream"><span class="Identifier">join</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="Other">(</span><span class="Identifier">CancelledError</span><span class="Other">,</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="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
@ -774,16 +672,54 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamIncorrectDefect,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamIncorrectDefect%2Cstring"><span class="Identifier">newLPStreamIncorrectDefect</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamIncorrectDefect"><span class="Identifier">LPStreamIncorrectDefect</span></a> {.
|
||||
<div id="newLPStreamClosedError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamClosedError"><span class="Identifier">newLPStreamClosedError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamClosedError"><span class="Identifier">LPStreamClosedError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L87"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamConnDownError,ref.Exception" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamConnDownError%2Cref.Exception"><span class="Identifier">newLPStreamConnDownError</span></a><span class="Other">(</span><span class="Identifier">parentException</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">Exception</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamConnDownError"><span class="Identifier">LPStreamConnDownError</span></a> {.
|
||||
<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L125"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L93"
|
||||
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#L93" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamEOFError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamEOFError"><span class="Identifier">newLPStreamEOFError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamEOFError"><span class="Identifier">LPStreamEOFError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L81"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamIncompleteError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamIncompleteError"><span class="Identifier">newLPStreamIncompleteError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamIncompleteError"><span class="Identifier">LPStreamIncompleteError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L75"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L75" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -794,35 +730,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L122"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L78"
|
||||
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>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamReadError,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamReadError%2Cstring"><span class="Identifier">newLPStreamReadError</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="Keyword">ref</span> <a href="lpstream.html#LPStreamReadError"><span class="Identifier">LPStreamReadError</span></a> {.<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L110"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L110" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamReadError,ref.CatchableError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamReadError%2Cref.CatchableError"><span class="Identifier">newLPStreamReadError</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">CatchableError</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamReadError"><span class="Identifier">LPStreamReadError</span></a> {.
|
||||
<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L104" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -833,9 +743,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L137"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L90"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L137" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -846,91 +756,69 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L131"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L84"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="newLPStreamWriteError,ref.CatchableError" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#newLPStreamWriteError%2Cref.CatchableError"><span class="Identifier">newLPStreamWriteError</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">CatchableError</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="lpstream.html#LPStreamWriteError"><span class="Identifier">LPStreamWriteError</span></a> {.
|
||||
<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>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L113"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L84" class="link-seesrc" target="_blank" >Edit</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">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">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="#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/message-id-mem/libp2p/stream/lpstream.nim#L186"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L186" class="link-seesrc" target="_blank" >Edit</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">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">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">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="#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/message-id-mem/libp2p/stream/lpstream.nim#L223"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L223" class="link-seesrc" target="_blank" >Edit</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">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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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="#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/message-id-mem/libp2p/stream/lpstream.nim#L267"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L267" class="link-seesrc" target="_blank" >Edit</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">Future</span><span class="Other">[</span><span class="Identifier">uint64</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><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">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">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="#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/message-id-mem/libp2p/stream/lpstream.nim#L249"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L249" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="setupStreamTracker,string" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setupStreamTracker%2Cstring"><span class="Identifier">setupStreamTracker</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="Other">:</span> <a href="lpstream.html#StreamTracker"><span class="Identifier">StreamTracker</span></a> {.<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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L80"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L80" 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>
|
||||
@ -940,48 +828,54 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L147"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L100"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L147" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L100" class="link-seesrc" target="_blank" >Edit</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/message-id-mem/libp2p/stream/lpstream.nim#L298"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L298" 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/message-id-mem/libp2p/stream/lpstream.nim#L287"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L287" 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/message-id-mem/libp2p/stream/lpstream.nim#L295"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L295" 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>
|
||||
@ -996,23 +890,23 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L170"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L170" 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">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">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/message-id-mem/libp2p/stream/lpstream.nim#L309"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L309" 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>
|
||||
@ -1022,62 +916,64 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L167"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L167" 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">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">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>
|
||||
|
||||
Implementation of close - called only once
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L301"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L301" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="initStream.e,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CLPStream"><span class="Identifier">initStream</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">base</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="Identifier">RootEffect</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/message-id-mem/libp2p/stream/lpstream.nim#L152"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L152" 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">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">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 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/message-id-mem/libp2p/stream/lpstream.nim#L177"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L177" 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>
|
||||
<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>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L283"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L283" 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>
|
||||
<div id="initStream.e,LPStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CLPStream"><span class="Identifier">initStream</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">base</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="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#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">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>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#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">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/message-id-mem/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#L251" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -1092,9 +988,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/stream/lpstream.nim#L150"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L150" 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>
|
||||
@ -1103,7 +999,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="19">
|
||||
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
||||
<dl class="item">
|
||||
<a href="../errors.html#toException,cstring"><span class="Identifier">toException</span></a>, <a href="../errors.html#toException,string"><span class="Identifier">toException</span></a>, <a href="../errors.html#allFuturesThrowing,varargs[Future[T]]"><span class="Identifier">allFuturesThrowing</span></a>, <a href="../errors.html#tryAndWarn.t,static[string],untyped"><span class="Identifier">tryAndWarn</span></a>, <a href="../errors.html#checkFutures.m,seq[F],untyped"><span class="Identifier">checkFutures</span></a>, <a href="../errors.html#LPError"><span class="Identifier">LPError</span></a>
|
||||
<a href="../errors.html#toException,cstring"><span class="Identifier">toException</span></a>, <a href="../errors.html#toException,string"><span class="Identifier">toException</span></a>, <a href="../errors.html#tryAndWarn.t,static[string],untyped"><span class="Identifier">tryAndWarn</span></a>, <a href="../errors.html#checkFutures.m,seq[F],untyped"><span class="Identifier">checkFutures</span></a>, <a href="../errors.html#LPError"><span class="Identifier">LPError</span></a>
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@ -1113,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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -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-19 14:51:28 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:54 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -215,10 +215,6 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
connectionsTimeout: Duration">TcpTransport</a></li>
|
||||
<li><a class="reference" href="#TcpTransportError"
|
||||
title="TcpTransportError = object of transport.TransportError">TcpTransportError</a></li>
|
||||
<li><a class="reference" href="#TcpTransportTracker"
|
||||
title="TcpTransportTracker = ref object of TrackerBase
|
||||
opened*: uint64
|
||||
closed*: uint64">TcpTransportTracker</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
@ -253,7 +249,12 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">dial
|
||||
<ul class="simple nested-toc-section">accept
|
||||
<li><a class="reference" href="#accept.e%2CTcpTransport"
|
||||
title="accept(self: TcpTransport): Future[Connection]">accept(self: TcpTransport): Future[Connection]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">dial
|
||||
<li><a class="reference" href="#dial.e%2CTcpTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D"
|
||||
title="dial(self: TcpTransport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]">dial(self: TcpTransport; hostname: string; address: MultiAddress;
|
||||
@ -329,21 +330,6 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L49"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="TcpTransportTracker" class="tohide">
|
||||
<dt><pre><a href="tcptransport.html#TcpTransportTracker"><span class="Identifier">TcpTransportTracker</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">TrackerBase</span>
|
||||
<span class="Identifier">opened</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
|
||||
<span class="Identifier">closed</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L45"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
@ -376,15 +362,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div id="connHandler,TcpTransport,StreamTransport,Opt[MultiAddress],Direction" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#connHandler%2CTcpTransport%2CStreamTransport%2COpt%5BMultiAddress%5D%2CDirection"><span class="Identifier">connHandler</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</span></a><span class="Other">;</span> <span class="Identifier">client</span><span class="Other">:</span> <span class="Identifier">StreamTransport</span><span class="Other">;</span>
|
||||
<span class="Identifier">observedAddr</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><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <a href="../stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</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/message-id-mem/libp2p/transports/tcptransport.nim#L78"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L50"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L50" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -396,9 +382,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L119"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L105"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L119" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L105" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -407,18 +393,31 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="14">
|
||||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="accept.e,TcpTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#accept.e%2CTcpTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</span></a><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>
|
||||
|
||||
accept a new TCP connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L199"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L199" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="dial.e,TcpTransport,string,MultiAddress,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CTcpTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</span></a><span class="Other">;</span> <span class="Identifier">hostname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">Opt</span><span class="Other">.</span><span class="Identifier">none</span><span class="Other">(</span><span class="Identifier">PeerId</span><span class="Other">)</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
dial a peer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L263"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L249"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L263" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -429,36 +428,36 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L282"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L268"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L282" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L268" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start.e,TcpTransport,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CTcpTransport%2Cseq%5BMultiAddress%5D"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
listen on the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L145"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L131"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,TcpTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CTcpTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</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><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">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">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="#stop.e%2CTcpTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="tcptransport.html#TcpTransport"><span class="Identifier">TcpTransport</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>
|
||||
|
||||
stop the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L177"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/tcptransport.nim#L163"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/tcptransport.nim#L163" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -467,7 +466,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="19">
|
||||
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
||||
<dl class="item">
|
||||
<a href="../upgrademngrs/upgrade.html#TransportInvalidAddrError"><span class="Identifier">TransportInvalidAddrError</span></a>, <a href="../upgrademngrs/upgrade.html#dial,Transport,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#upgrade.e,Transport,Connection,Direction,Opt[PeerId]"><span class="Identifier">upgrade</span></a>, <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a>, <a href="../upgrademngrs/upgrade.html#newTransportClosedError,ref.Exception"><span class="Identifier">newTransportClosedError</span></a>, <a href="../upgrademngrs/upgrade.html#stop.e,Transport"><span class="Identifier">stop</span></a>, <a href="../upgrademngrs/upgrade.html#accept.e,Transport"><span class="Identifier">accept</span></a>, <a href="../upgrademngrs/upgrade.html#TransportError"><span class="Identifier">TransportError</span></a>, <a href="../upgrademngrs/upgrade.html#TransportClosedError"><span class="Identifier">TransportClosedError</span></a>, <a href="../protocols/connectivity/autonat/core.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a>, <a href="../upgrademngrs/upgrade.html#handles.e,Transport,MultiAddress"><span class="Identifier">handles</span></a>, <a href="../upgrademngrs/upgrade.html#dial.e,Transport,string,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#start.e,Transport,seq[MultiAddress]"><span class="Identifier">start</span></a>
|
||||
<a href="../upgrademngrs/upgrade.html#TransportInvalidAddrError"><span class="Identifier">TransportInvalidAddrError</span></a>, <a href="../upgrademngrs/upgrade.html#dial,Transport,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#upgrade.e,Transport,Connection,Opt[PeerId]"><span class="Identifier">upgrade</span></a>, <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a>, <a href="../upgrademngrs/upgrade.html#newTransportClosedError,ref.Exception"><span class="Identifier">newTransportClosedError</span></a>, <a href="../upgrademngrs/upgrade.html#stop.e,Transport"><span class="Identifier">stop</span></a>, <a href="../upgrademngrs/upgrade.html#accept.e,Transport"><span class="Identifier">accept</span></a>, <a href="../upgrademngrs/upgrade.html#TransportError"><span class="Identifier">TransportError</span></a>, <a href="../upgrademngrs/upgrade.html#TransportClosedError"><span class="Identifier">TransportClosedError</span></a>, <a href="../protocols/connectivity/autonat/core.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a>, <a href="../upgrademngrs/upgrade.html#handles.e,Transport,MultiAddress"><span class="Identifier">handles</span></a>, <a href="../upgrademngrs/upgrade.html#dial.e,Transport,string,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#start.e,Transport,seq[MultiAddress]"><span class="Identifier">start</span></a>
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@ -477,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -269,10 +269,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">upgrade
|
||||
<li><a class="reference" href="#upgrade.e%2CTransport%2CConnection%2CDirection%2COpt%5BPeerId%5D"
|
||||
title="upgrade(self: Transport; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]">upgrade(self: Transport; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
<li><a class="reference" href="#upgrade.e%2CTransport%2CConnection%2COpt%5BPeerId%5D"
|
||||
title="upgrade(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]">upgrade(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -429,15 +427,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
check if transport supports the multiaddress
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/transport.nim#L94"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/transport.nim#L93"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/transport.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/transports/transport.nim#L93" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="start.e,Transport,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CTransport%2Cseq%5BMultiAddress%5D"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
@ -450,8 +448,8 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="stop.e,Transport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</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">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">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="#stop.e%2CTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</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>
|
||||
<dd>
|
||||
|
||||
stop and cleanup the transport including all outstanding connections
|
||||
@ -462,10 +460,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
<div id="upgrade.e,Transport,Connection,Direction,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#upgrade.e%2CTransport%2CConnection%2CDirection%2COpt%5BPeerId%5D"><span class="Identifier">upgrade</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</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">direction</span><span class="Other">:</span> <a href="../stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">]</span> {.<span class="Identifier">base</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>
|
||||
<div id="upgrade.e,Transport,Connection,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#upgrade.e%2CTransport%2CConnection%2COpt%5BPeerId%5D"><span class="Identifier">upgrade</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</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">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">]</span> {.<span class="Identifier">base</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>
|
||||
<dd>
|
||||
|
||||
base upgrade method that the transport uses to perform transport specific upgrades
|
||||
@ -491,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -263,7 +263,14 @@ 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
|
||||
<li><a class="reference" href="#dial.e%2CWsTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D"
|
||||
title="dial(self: WsTransport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]">dial(self: WsTransport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">getWrapped
|
||||
@ -283,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
|
||||
@ -298,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>
|
||||
|
||||
@ -349,9 +360,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L98"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L98" 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>
|
||||
@ -383,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/message-id-mem/libp2p/transports/wstransport.nim#L346"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L346" 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>
|
||||
@ -399,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/message-id-mem/libp2p/transports/wstransport.nim#L324"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L324" 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>
|
||||
@ -411,9 +422,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L113"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L113" 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>
|
||||
@ -423,29 +434,44 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="accept.e,WsTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#accept.e%2CWsTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</span></a><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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
||||
</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">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">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="#accept.e%2CWsTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</span></a><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>
|
||||
|
||||
accept a new WS connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L240"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L240" 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">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">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/message-id-mem/libp2p/transports/wstransport.nim#L91"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L91" 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>
|
||||
<div id="dial.e,WsTransport,string,MultiAddress,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CWsTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</span></a><span class="Other">;</span> <span class="Identifier">hostname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">Opt</span><span class="Other">.</span><span class="Identifier">none</span><span class="Other">(</span><span class="Identifier">PeerId</span><span class="Other">)</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>
|
||||
|
||||
dial a peer
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L308" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -455,9 +481,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L95"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L95" 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>
|
||||
@ -468,14 +494,14 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L319"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L319" 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>
|
||||
<div id="initStream.e,WsStream" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CWsStream"><span class="Identifier">initStream</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><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 class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CWsStream"><span class="Identifier">initStream</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><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">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
@ -487,56 +513,58 @@ 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">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">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/message-id-mem/libp2p/transports/wstransport.nim#L77"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L77" 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>
|
||||
<div id="start.e,WsTransport,seq[MultiAddress]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CWsTransport%2Cseq%5BMultiAddress%5D"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><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">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">raises</span><span class="Other">:</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">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>
|
||||
|
||||
listen on the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L118"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L118" 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>
|
||||
<div id="stop.e,WsTransport" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CWsTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</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><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">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">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="#stop.e%2CWsTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wstransport.html#WsTransport"><span class="Identifier">WsTransport</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>
|
||||
|
||||
stop the transport
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/transports/wstransport.nim#L176"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L176" 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">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">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/message-id-mem/libp2p/transports/wstransport.nim#L87"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/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#L87" 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>
|
||||
@ -545,7 +573,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="19">
|
||||
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
||||
<dl class="item">
|
||||
<a href="../upgrademngrs/upgrade.html#TransportInvalidAddrError"><span class="Identifier">TransportInvalidAddrError</span></a>, <a href="../upgrademngrs/upgrade.html#dial,Transport,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#upgrade.e,Transport,Connection,Direction,Opt[PeerId]"><span class="Identifier">upgrade</span></a>, <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a>, <a href="../upgrademngrs/upgrade.html#newTransportClosedError,ref.Exception"><span class="Identifier">newTransportClosedError</span></a>, <a href="../upgrademngrs/upgrade.html#stop.e,Transport"><span class="Identifier">stop</span></a>, <a href="../upgrademngrs/upgrade.html#accept.e,Transport"><span class="Identifier">accept</span></a>, <a href="../upgrademngrs/upgrade.html#TransportError"><span class="Identifier">TransportError</span></a>, <a href="../upgrademngrs/upgrade.html#TransportClosedError"><span class="Identifier">TransportClosedError</span></a>, <a href="../protocols/connectivity/autonat/core.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a>, <a href="../upgrademngrs/upgrade.html#handles.e,Transport,MultiAddress"><span class="Identifier">handles</span></a>, <a href="../upgrademngrs/upgrade.html#dial.e,Transport,string,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#start.e,Transport,seq[MultiAddress]"><span class="Identifier">start</span></a>
|
||||
<a href="../upgrademngrs/upgrade.html#TransportInvalidAddrError"><span class="Identifier">TransportInvalidAddrError</span></a>, <a href="../upgrademngrs/upgrade.html#dial,Transport,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#upgrade.e,Transport,Connection,Opt[PeerId]"><span class="Identifier">upgrade</span></a>, <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a>, <a href="../upgrademngrs/upgrade.html#newTransportClosedError,ref.Exception"><span class="Identifier">newTransportClosedError</span></a>, <a href="../upgrademngrs/upgrade.html#stop.e,Transport"><span class="Identifier">stop</span></a>, <a href="../upgrademngrs/upgrade.html#accept.e,Transport"><span class="Identifier">accept</span></a>, <a href="../upgrademngrs/upgrade.html#TransportError"><span class="Identifier">TransportError</span></a>, <a href="../upgrademngrs/upgrade.html#TransportClosedError"><span class="Identifier">TransportClosedError</span></a>, <a href="../protocols/connectivity/autonat/core.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a>, <a href="../upgrademngrs/upgrade.html#handles.e,Transport,MultiAddress"><span class="Identifier">handles</span></a>, <a href="../upgrademngrs/upgrade.html#dial.e,Transport,string,MultiAddress,Opt[PeerId]"><span class="Identifier">dial</span></a>, <a href="../upgrademngrs/upgrade.html#start.e,Transport,seq[MultiAddress]"><span class="Identifier">start</span></a>
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@ -555,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-19 14:51:30 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -216,8 +216,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">mux
|
||||
<li><a class="reference" href="#mux%2CMuxedUpgrade%2CConnection%2CDirection"
|
||||
title="mux(self: MuxedUpgrade; conn: Connection; direction: Direction): Future[Muxer]">mux(self: MuxedUpgrade; conn: Connection; direction: Direction): Future[Muxer]</a></li>
|
||||
<li><a class="reference" href="#mux%2CMuxedUpgrade%2CConnection"
|
||||
title="mux(self: MuxedUpgrade; conn: Connection): Future[Muxer]">mux(self: MuxedUpgrade; conn: Connection): Future[Muxer]</a></li>
|
||||
|
||||
</ul>
|
||||
<ul class="simple nested-toc-section">new
|
||||
@ -234,10 +234,8 @@ window.addEventListener("DOMContentLoaded", main2);
|
||||
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<ul class="simple nested-toc-section">upgrade
|
||||
<li><a class="reference" href="#upgrade.e%2CMuxedUpgrade%2CConnection%2CDirection%2COpt%5BPeerId%5D"
|
||||
title="upgrade(self: MuxedUpgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]">upgrade(self: MuxedUpgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
<li><a class="reference" href="#upgrade.e%2CMuxedUpgrade%2CConnection%2COpt%5BPeerId%5D"
|
||||
title="upgrade(self: MuxedUpgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]">upgrade(self: MuxedUpgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
@ -290,17 +288,17 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="mux,MuxedUpgrade,Connection,Direction" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#mux%2CMuxedUpgrade%2CConnection%2CDirection"><span class="Identifier">mux</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="muxedupgrade.html#MuxedUpgrade"><span class="Identifier">MuxedUpgrade</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">direction</span><span class="Other">:</span> <a href="../stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </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">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">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="mux,MuxedUpgrade,Connection" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#mux%2CMuxedUpgrade%2CConnection"><span class="Identifier">mux</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="muxedupgrade.html#MuxedUpgrade"><span class="Identifier">MuxedUpgrade</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="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</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>
|
||||
|
||||
mux connection
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L36"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L35"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -312,9 +310,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L90"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L88"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L88" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -323,17 +321,17 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<div class="section" id="14">
|
||||
<h1><a class="toc-backref" href="#14">Methods</a></h1>
|
||||
<dl class="item">
|
||||
<div id="upgrade.e,MuxedUpgrade,Connection,Direction,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#upgrade.e%2CMuxedUpgrade%2CConnection%2CDirection%2COpt%5BPeerId%5D"><span class="Identifier">upgrade</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="muxedupgrade.html#MuxedUpgrade"><span class="Identifier">MuxedUpgrade</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">direction</span><span class="Other">:</span> <a href="../stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</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">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">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="upgrade.e,MuxedUpgrade,Connection,Opt[PeerId]" class="tohide">
|
||||
<dt><pre><span class="Keyword">method</span> <a href="#upgrade.e%2CMuxedUpgrade%2CConnection%2COpt%5BPeerId%5D"><span class="Identifier">upgrade</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="muxedupgrade.html#MuxedUpgrade"><span class="Identifier">MuxedUpgrade</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">peerId</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
||||
<a href="../muxers/muxer.html#Muxer"><span class="Identifier">Muxer</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/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L66"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/upgrademngrs/muxedupgrade.nim#L64"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/upgrademngrs/muxedupgrade.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -352,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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:57 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -330,9 +330,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L96"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L115"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L96" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L115" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -395,9 +395,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L111"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L130"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L111" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L130" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -407,9 +407,9 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L105"
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L124"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L105" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
</div>
|
||||
@ -417,6 +417,15 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dt><pre><span class="Keyword">template</span> <a href="#withValue.t%2C%2Cuntyped%2Cuntyped"><span class="Identifier">withValue</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Operator">|</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>This template provides a convenient way to work with <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> types in Nim. It allows you to execute a block of code (<tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt>) only when the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> is not empty.</p>
|
||||
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">self</span></span></tt> is the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> instance being checked. <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> is the variable name to be used within the <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> for the unwrapped value. <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> is a block of code that is executed only if <tt class="docutils literal"><span class="pre"><span class="Identifier">self</span></span></tt> contains a value.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> within <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> is automatically unwrapped from the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt>, making it simpler to work with without needing explicit checks or unwrapping.</p>
|
||||
<p>Example:</p>
|
||||
<p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">myOpt</span> <span class="Operator">=</span> <span class="Identifier">Opt</span><span class="Operator">.</span><span class="Identifier">some</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
|
||||
<span class="Identifier">myOpt</span><span class="Operator">.</span><span class="Identifier">withValue</span><span class="Punctuation">(</span><span class="Identifier">value</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
|
||||
<span class="Identifier">echo</span> <span class="Identifier">value</span> <span class="Comment"># Will print 5</span>
|
||||
</pre></p>
|
||||
<p>Note: This is a template, and it will be inlined at the call site, offering good performance.</p>
|
||||
|
||||
<a
|
||||
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/utility.nim#L91"
|
||||
@ -435,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-19 14:51:25 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:51 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -250,7 +250,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<dl class="item">
|
||||
<div id="anyCompleted,seq[Future[T]]" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#anyCompleted%2Cseq%5BFuture%5BT%5D%5D"><span class="Identifier">anyCompleted</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">futs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">T</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">Future</span><span class="Other">[</span><span class="Identifier">T</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">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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||||
<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>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Returns a future that will complete with the first future that completes. If all futures fail or futs is empty, the returned future will fail with AllFuturesFailedError.
|
||||
@ -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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -281,7 +281,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<div id="acquire,AsyncSemaphore" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#acquire%2CAsyncSemaphore"><span class="Identifier">acquire</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="semaphore.html#AsyncSemaphore"><span class="Identifier">AsyncSemaphore</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">proc</span> <a href="#acquire%2CAsyncSemaphore"><span class="Identifier">acquire</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="semaphore.html#AsyncSemaphore"><span class="Identifier">AsyncSemaphore</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="Other">]</span></span>.}</pre></dt>
|
||||
<dd>
|
||||
|
||||
Acquire a resource and decrement the resource counter. If no more resources are available, the returned future will not complete until the resource count goes above 0.
|
||||
@ -329,7 +329,7 @@ class="link-seesrc" target="_blank">Source</a>
|
||||
</dd>
|
||||
</div>
|
||||
<div id="release,AsyncSemaphore" class="tohide">
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#release%2CAsyncSemaphore"><span class="Identifier">release</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="semaphore.html#AsyncSemaphore"><span class="Identifier">AsyncSemaphore</span></a><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">proc</span> <a href="#release%2CAsyncSemaphore"><span class="Identifier">release</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="semaphore.html#AsyncSemaphore"><span class="Identifier">AsyncSemaphore</span></a><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>
|
||||
<dd>
|
||||
|
||||
Release a resource from the semaphore, by picking the first future from the queue and completing it and incrementing the internal resource count
|
||||
@ -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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:55 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-19 14:51:25 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:51 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-19 14:51:26 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:53 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-19 14:51:29 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:56 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -217,6 +217,8 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rtransport: accept(self: RelayTransport): Future[Connection]" href="libp2p/protocols/connectivity/relay/rtransport.html#accept.e%2CRelayTransport">rtransport: accept(self: RelayTransport): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="tcptransport: accept(self: TcpTransport): Future[Connection]" href="libp2p/transports/tcptransport.html#accept.e%2CTcpTransport">tcptransport: accept(self: TcpTransport): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="transport: accept(self: Transport): Future[Connection]" href="libp2p/transports/transport.html#accept.e%2CTransport">transport: accept(self: Transport): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: accept(self: WsTransport): Future[Connection]" href="libp2p/transports/wstransport.html#accept.e%2CWsTransport">wstransport: accept(self: WsTransport): Future[Connection]</a></li>
|
||||
@ -335,10 +337,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="future: AllFuturesFailedError" href="libp2p/utils/future.html#AllFuturesFailedError">future: AllFuturesFailedError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="allFuturesThrowing" href="#allFuturesThrowing"><span>allFuturesThrowing:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="errors: allFuturesThrowing[T](args: varargs[Future[T]]): Future[void]" href="libp2p/errors.html#allFuturesThrowing%2Cvarargs%5BFuture%5BT%5D%5D">errors: allFuturesThrowing[T](args: varargs[Future[T]]): Future[void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="AlreadyExpectingConnectionError" href="#AlreadyExpectingConnectionError"><span>AlreadyExpectingConnectionError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: AlreadyExpectingConnectionError" href="libp2p/connmanager.html#AlreadyExpectingConnectionError">connmanager: AlreadyExpectingConnectionError</a></li>
|
||||
@ -551,11 +549,13 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="bridge" href="#bridge"><span>bridge:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="utils: bridge(connSrc: Connection; connDst: Connection): Future[void]" href="libp2p/protocols/connectivity/relay/utils.html#bridge%2CConnection%2CConnection">utils: bridge(connSrc: Connection; connDst: Connection): Future[void]</a></li>
|
||||
data-doc-search-tag="utils: bridge(connSrc: Connection; connDst: Connection): InternalRaisesFuture[void,
|
||||
(CancelledError,)]" href="libp2p/protocols/connectivity/relay/utils.html#bridge%2CConnection%2CConnection">utils: bridge(connSrc: Connection; connDst: Connection): InternalRaisesFuture[void,
|
||||
(CancelledError,)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="broadcast" href="#broadcast"><span>broadcast:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsub: broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg)" href="libp2p/protocols/pubsub/pubsub.html#broadcast%2CPubSub%2Cauto%2CRPCMsg">pubsub: broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg)</a></li>
|
||||
data-doc-search-tag="pubsub: broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg; isHighPriority: bool)" href="libp2p/protocols/pubsub/pubsub.html#broadcast%2CPubSub%2Cauto%2CRPCMsg%2Cbool">pubsub: broadcast(p: PubSub; sendPeers: auto; msg: RPCMsg; isHighPriority: bool)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="BufferStream" href="#BufferStream"><span>BufferStream:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -665,11 +665,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="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="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="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="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="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="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): 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"
|
||||
@ -679,27 +681,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"
|
||||
@ -748,17 +750,17 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
PeerId]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="dial: connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]" href="libp2p/dial.html#connect.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D">dial: connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]</a></li>
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]" href="libp2p/dial.html#connect.e%2CDial%2CPeerId%2Cseq%5BMultiAddress%5D">dial: connect(self: Dial; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="dialer: connect(self: Dialer; address: MultiAddress; allowUnknownPeerId = false): Future[
|
||||
PeerId]" href="libp2p/dialer.html#connect.e%2CDialer%2CMultiAddress">dialer: connect(self: Dialer; address: MultiAddress; allowUnknownPeerId = false): Future[
|
||||
PeerId]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="dialer: connect(self: Dialer; peerId: PeerId; addrs: seq[MultiAddress];
|
||||
forceDial = false; reuseConnection = true; upgradeDir = Direction.Out): Future[
|
||||
forceDial = false; reuseConnection = true; dir = Direction.Out): Future[
|
||||
void]" href="libp2p/dialer.html#connect.e%2CDialer%2CPeerId%2Cseq%5BMultiAddress%5D">dialer: connect(self: Dialer; peerId: PeerId; addrs: seq[MultiAddress];
|
||||
forceDial = false; reuseConnection = true; upgradeDir = Direction.Out): Future[
|
||||
forceDial = false; reuseConnection = true; dir = Direction.Out): Future[
|
||||
void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: connect(p: PubSubPeer)" href="libp2p/protocols/pubsub/pubsubpeer.html#connect%2CPubSubPeer">pubsubpeer: connect(p: PubSubPeer)</a></li>
|
||||
@ -768,8 +770,8 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
PeerId]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="switch: connect(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]" href="libp2p/switch.html#connect.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D">switch: connect(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; upgradeDir = Direction.Out): Future[void]</a></li>
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]" href="libp2p/switch.html#connect.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D">switch: connect(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
|
||||
reuseConnection = true; dir = Direction.Out): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wire: connect(ma: MultiAddress; bufferSize = DefaultStreamBufferSize;
|
||||
child: StreamTransport = nil; flags = default(set[SocketFlags]);
|
||||
@ -1165,6 +1167,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="transport: dial(self: Transport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]" href="libp2p/transports/transport.html#dial.e%2CTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D">transport: dial(self: Transport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: dial(self: WsTransport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]" href="libp2p/transports/wstransport.html#dial.e%2CWsTransport%2Cstring%2CMultiAddress%2COpt%5BPeerId%5D">wstransport: dial(self: WsTransport; hostname: string; address: MultiAddress;
|
||||
peerId: Opt[PeerId] = Opt.none(PeerId)): Future[Connection]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="Dialer" href="#Dialer"><span>Dialer:</span></a></dt><dd><ul class="simple">
|
||||
@ -1697,6 +1703,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="nameresolver: getHostname(ma: MultiAddress): string" href="libp2p/nameresolving/nameresolver.html#getHostname%2CMultiAddress">nameresolver: getHostname(ma: MultiAddress): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="getIncomingSlot" href="#getIncomingSlot"><span>getIncomingSlot:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: getIncomingSlot(c: ConnManager): Future[ConnectionSlot]" href="libp2p/connmanager.html#getIncomingSlot%2CConnManager">connmanager: getIncomingSlot(c: ConnManager): Future[ConnectionSlot]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="getLen" href="#getLen"><span>getLen:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="minprotobuf: getLen(pb: ProtoBuffer): int" href="libp2p/protobuf/minprotobuf.html#getLen.t%2CProtoBuffer">minprotobuf: getLen(pb: ProtoBuffer): int</a></li>
|
||||
@ -1805,6 +1815,8 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="getStream" href="#getStream"><span>getStream:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: getStream(c: ConnManager; muxer: Muxer): Future[Connection]" href="libp2p/connmanager.html#getStream%2CConnManager%2CMuxer">connmanager: getStream(c: ConnManager; muxer: Muxer): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: getStream(c: ConnManager; peerId: PeerId): Future[Connection]" href="libp2p/connmanager.html#getStream%2CConnManager%2CPeerId">connmanager: getStream(c: ConnManager; peerId: PeerId): Future[Connection]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: getStream(c: ConnManager; peerId: PeerId; dir: Direction): Future[Connection]" href="libp2p/connmanager.html#getStream%2CConnManager%2CPeerId%2CDirection">connmanager: getStream(c: ConnManager; peerId: PeerId; dir: Direction): Future[Connection]</a></li>
|
||||
@ -1913,17 +1925,19 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="handle" href="#handle"><span>handle:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: handle(m: MultistreamSelect; conn: Connection; active: bool = false): Future[
|
||||
void]" href="libp2p/multistream.html#handle%2CMultistreamSelect%2CConnection%2Cbool">multistream: handle(m: MultistreamSelect; conn: Connection; active: bool = false): Future[
|
||||
void]</a></li>
|
||||
data-doc-search-tag="multistream: handle(m: MultistreamSelect; conn: Connection; active: bool = false): InternalRaisesFuture[
|
||||
void, (CancelledError,)]" href="libp2p/multistream.html#handle%2CMultistreamSelect%2CConnection%2Cbool">multistream: handle(m: MultistreamSelect; conn: Connection; active: bool = false): InternalRaisesFuture[
|
||||
void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: handle(_: type MultistreamSelect; conn: Connection; protos: seq[string];
|
||||
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>
|
||||
matchers = newSeq[Matcher](); active: bool = false): InternalRaisesFuture[
|
||||
string, (CancelledError, LPStreamError, MultiStreamError)]" 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): InternalRaisesFuture[
|
||||
string, (CancelledError, LPStreamError, MultiStreamError)]</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>
|
||||
@ -1993,13 +2007,13 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="handshake" href="#handshake"><span>handshake:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="noise: handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]" href="libp2p/protocols/secure/noise.html#handshake.e%2CNoise%2CConnection%2Cbool%2COpt%5BPeerId%5D">noise: handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]</a></li>
|
||||
data-doc-search-tag="noise: handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]" href="libp2p/protocols/secure/noise.html#handshake.e%2CNoise%2CConnection%2Cbool%2COpt%5BPeerId%5D">noise: handshake(p: Noise; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="secure: handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]" href="libp2p/protocols/secure/secure.html#handshake.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D">secure: handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
SecureConn]</a></li>
|
||||
data-doc-search-tag="secure: handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]" href="libp2p/protocols/secure/secure.html#handshake.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D">secure: handshake(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
SecureConn, (CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="hash" href="#hash"><span>hash:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -2292,6 +2306,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
data-doc-search-tag="secp: init(t: typedesc[SkSignature]; data: string): SkResult[SkSignature]" href="libp2p/crypto/secp.html#init%2Ctypedesc%5BSkSignature%5D%2Cstring">secp: init(t: typedesc[SkSignature]; data: string): SkResult[SkSignature]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multiaddress: init(mtype: typedesc[MultiAddress]): MultiAddress" href="libp2p/multiaddress.html#init%2Ctypedesc%5BMultiAddress%5D">multiaddress: init(mtype: typedesc[MultiAddress]): MultiAddress</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multiaddress: init(mtype: typedesc[MultiAddress]; address: IpAddress;
|
||||
protocol: IpTransportProtocol; port: Port): MultiAddress" href="libp2p/multiaddress.html#init%2Ctypedesc%5BMultiAddress%5D%2CIpAddress%2CIpTransportProtocol%2CPort">multiaddress: init(mtype: typedesc[MultiAddress]; address: IpAddress;
|
||||
protocol: IpTransportProtocol; port: Port): MultiAddress</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multiaddress: init(mtype: typedesc[MultiAddress]; protocol: MultiCodec; value: int): MaResult[
|
||||
MultiAddress]" href="libp2p/multiaddress.html#init%2Ctypedesc%5BMultiAddress%5D%2CMultiCodec%2Cint">multiaddress: init(mtype: typedesc[MultiAddress]; protocol: MultiCodec; value: int): MaResult[
|
||||
@ -2314,10 +2332,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
data-doc-search-tag="multiaddress: init(mtype: typedesc[MultiAddress]; address: TransportAddress;
|
||||
protocol = IPPROTO_TCP): MaResult[MultiAddress]" href="libp2p/multiaddress.html#init%2Ctypedesc%5BMultiAddress%5D%2CTransportAddress">multiaddress: init(mtype: typedesc[MultiAddress]; address: TransportAddress;
|
||||
protocol = IPPROTO_TCP): MaResult[MultiAddress]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multiaddress: init(mtype: typedesc[MultiAddress]; address: ValidIpAddress;
|
||||
protocol: IpTransportProtocol; port: Port): MultiAddress" href="libp2p/multiaddress.html#init%2Ctypedesc%5BMultiAddress%5D%2CValidIpAddress%2CIpTransportProtocol%2CPort">multiaddress: init(mtype: typedesc[MultiAddress]; address: ValidIpAddress;
|
||||
protocol: IpTransportProtocol; port: Port): MultiAddress</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multihash: init[T](mhtype: typedesc[MultiHash]; hashcode: MultiCodec; mdigest: MDigest[T]): MhResult[
|
||||
MultiHash]" href="libp2p/multihash.html#init%2Ctypedesc%5BMultiHash%5D%2CMultiCodec%2CMDigest%5BT%5D">multihash: init[T](mhtype: typedesc[MultiHash]; hashcode: MultiCodec; mdigest: MDigest[T]): MhResult[
|
||||
@ -2597,7 +2611,7 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="join" href="#join"><span>join:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: join(s: LPStream): Future[void]" href="libp2p/stream/lpstream.html#join%2CLPStream">lpstream: join(s: LPStream): Future[void]</a></li>
|
||||
data-doc-search-tag="lpstream: join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/stream/lpstream.html#join%2CLPStream">lpstream: join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="key" href="#key"><span>key:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -2731,7 +2745,9 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="list" href="#list"><span>list:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: list(m: MultistreamSelect; conn: Connection): Future[seq[string]]" href="libp2p/multistream.html#list%2CMultistreamSelect%2CConnection">multistream: list(m: MultistreamSelect; conn: Connection): Future[seq[string]]</a></li>
|
||||
data-doc-search-tag="multistream: list(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[seq[string],
|
||||
(CancelledError, LPStreamError, MultiStreamError)]" href="libp2p/multistream.html#list%2CMultistreamSelect%2CConnection">multistream: list(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[seq[string],
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="low" href="#low"><span>low:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -2785,18 +2801,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamIncompleteError" href="libp2p/stream/lpstream.html#LPStreamIncompleteError">lpstream: LPStreamIncompleteError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="LPStreamIncorrectDefect" href="#LPStreamIncorrectDefect"><span>LPStreamIncorrectDefect:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamIncorrectDefect" href="libp2p/stream/lpstream.html#LPStreamIncorrectDefect">lpstream: LPStreamIncorrectDefect</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="LPStreamLimitError" href="#LPStreamLimitError"><span>LPStreamLimitError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamLimitError" href="libp2p/stream/lpstream.html#LPStreamLimitError">lpstream: LPStreamLimitError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="LPStreamReadError" href="#LPStreamReadError"><span>LPStreamReadError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamReadError" href="libp2p/stream/lpstream.html#LPStreamReadError">lpstream: LPStreamReadError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="LPStreamRemoteClosedError" href="#LPStreamRemoteClosedError"><span>LPStreamRemoteClosedError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamRemoteClosedError" href="libp2p/stream/lpstream.html#LPStreamRemoteClosedError">lpstream: LPStreamRemoteClosedError</a></li>
|
||||
@ -2809,10 +2817,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamTrackerName" href="libp2p/stream/lpstream.html#LPStreamTrackerName">lpstream: LPStreamTrackerName</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="LPStreamWriteError" href="#LPStreamWriteError"><span>LPStreamWriteError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: LPStreamWriteError" href="libp2p/stream/lpstream.html#LPStreamWriteError">lpstream: LPStreamWriteError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="mac" href="#mac"><span>mac:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="crypto: mac(secret: Secret; id: int): seq[byte]" href="libp2p/crypto/crypto.html#mac%2CSecret%2Cint">crypto: mac(secret: Secret; id: int): seq[byte]</a></li>
|
||||
@ -3041,7 +3045,7 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="mux" href="#mux"><span>mux:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxedupgrade: mux(self: MuxedUpgrade; conn: Connection; direction: Direction): Future[Muxer]" href="libp2p/upgrademngrs/muxedupgrade.html#mux%2CMuxedUpgrade%2CConnection%2CDirection">muxedupgrade: mux(self: MuxedUpgrade; conn: Connection; direction: Direction): Future[Muxer]</a></li>
|
||||
data-doc-search-tag="muxedupgrade: mux(self: MuxedUpgrade; conn: Connection): Future[Muxer]" href="libp2p/upgrademngrs/muxedupgrade.html#mux%2CMuxedUpgrade%2CConnection">muxedupgrade: mux(self: MuxedUpgrade; conn: Connection): Future[Muxer]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="MuxedUpgrade" href="#MuxedUpgrade"><span>MuxedUpgrade:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -3099,7 +3103,13 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxer: new(T: typedesc[MuxerProvider]; creator: MuxerConstructor; codec: string): T:type" href="libp2p/muxers/muxer.html#new%2Ctypedesc%5BMuxerProvider%5D%2CMuxerConstructor%2Cstring">muxer: new(T: typedesc[MuxerProvider]; creator: MuxerConstructor; codec: string): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount): T:type" href="libp2p/muxers/yamux/yamux.html#new%2Ctype%5BYamux%5D%2CConnection%2Cint">yamux: new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount): T:type</a></li>
|
||||
data-doc-search-tag="yamux: new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
||||
windowSize: int = YamuxDefaultWindowSize;
|
||||
maxSendQueueSize: int = MaxSendQueueSize; inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes): T:type" href="libp2p/muxers/yamux/yamux.html#new%2Ctype%5BYamux%5D%2CConnection%2Cint%2Cint%2Cint%2CDuration%2CDuration">yamux: new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
||||
windowSize: int = YamuxDefaultWindowSize;
|
||||
maxSendQueueSize: int = MaxSendQueueSize; inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="observedaddrmanager: new(T: typedesc[ObservedAddrManager]; maxSize = 10; minCount = 3): T:type" href="libp2p/observedaddrmanager.html#new%2Ctypedesc%5BObservedAddrManager%5D%2Cint%2Cint">observedaddrmanager: new(T: typedesc[ObservedAddrManager]; maxSize = 10; minCount = 3): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
@ -3147,7 +3157,9 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rtransport: new(T: typedesc[RelayTransport]; cl: RelayClient; upgrader: Upgrade): T:type" href="libp2p/protocols/connectivity/relay/rtransport.html#new%2Ctypedesc%5BRelayTransport%5D%2CRelayClient%2CUpgrade">rtransport: new(T: typedesc[RelayTransport]; cl: RelayClient; upgrader: Upgrade): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="identify: new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type" href="libp2p/protocols/identify.html#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo">identify: new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type</a></li>
|
||||
data-doc-search-tag="identify: new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false;
|
||||
observedAddrManager = ObservedAddrManager.new()): T:type" href="libp2p/protocols/identify.html#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo">identify: new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false;
|
||||
observedAddrManager = ObservedAddrManager.new()): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="identify: new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type" href="libp2p/protocols/identify.html#new%2Ctypedesc%5BIdentifyPush%5D%2CIdentifyPushHandler">identify: new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type</a></li>
|
||||
<li><a class="reference external"
|
||||
@ -3239,20 +3251,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamIncompleteError(): ref LPStreamIncompleteError" href="libp2p/stream/lpstream.html#newLPStreamIncompleteError">lpstream: newLPStreamIncompleteError(): ref LPStreamIncompleteError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newLPStreamIncorrectDefect" href="#newLPStreamIncorrectDefect"><span>newLPStreamIncorrectDefect:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamIncorrectDefect(m: string): ref LPStreamIncorrectDefect" href="libp2p/stream/lpstream.html#newLPStreamIncorrectDefect%2Cstring">lpstream: newLPStreamIncorrectDefect(m: string): ref LPStreamIncorrectDefect</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newLPStreamLimitError" href="#newLPStreamLimitError"><span>newLPStreamLimitError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamLimitError(): ref LPStreamLimitError" href="libp2p/stream/lpstream.html#newLPStreamLimitError">lpstream: newLPStreamLimitError(): ref LPStreamLimitError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newLPStreamReadError" href="#newLPStreamReadError"><span>newLPStreamReadError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamReadError(p: ref CatchableError): ref LPStreamReadError" href="libp2p/stream/lpstream.html#newLPStreamReadError%2Cref.CatchableError">lpstream: newLPStreamReadError(p: ref CatchableError): ref LPStreamReadError</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamReadError(msg: string): ref LPStreamReadError" href="libp2p/stream/lpstream.html#newLPStreamReadError%2Cstring">lpstream: newLPStreamReadError(msg: string): ref LPStreamReadError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newLPStreamRemoteClosedError" href="#newLPStreamRemoteClosedError"><span>newLPStreamRemoteClosedError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamRemoteClosedError(): ref LPStreamRemoteClosedError" href="libp2p/stream/lpstream.html#newLPStreamRemoteClosedError">lpstream: newLPStreamRemoteClosedError(): ref LPStreamRemoteClosedError</a></li>
|
||||
@ -3261,10 +3263,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamResetError(): ref LPStreamResetError" href="libp2p/stream/lpstream.html#newLPStreamResetError">lpstream: newLPStreamResetError(): ref LPStreamResetError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newLPStreamWriteError" href="#newLPStreamWriteError"><span>newLPStreamWriteError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: newLPStreamWriteError(p: ref CatchableError): ref LPStreamWriteError" href="libp2p/stream/lpstream.html#newLPStreamWriteError%2Cref.CatchableError">lpstream: newLPStreamWriteError(p: ref CatchableError): ref LPStreamWriteError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="newRng" href="#newRng"><span>newRng:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="crypto: newRng(): ref HmacDrbgContext" href="libp2p/crypto/crypto.html#newRng">crypto: newRng(): ref HmacDrbgContext</a></li>
|
||||
@ -3272,19 +3270,19 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<dt><a name="newStandardSwitch" href="#newStandardSwitch"><span>newStandardSwitch:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="builders: newStandardSwitch(privKey = none(PrivateKey); addrs: MultiAddress |
|
||||
seq[MultiAddress] = init(MultiAddress, "/ip4/127.0.0.1/tcp/0").tryGet();
|
||||
secureManagers: openArray[SecureProtocol] = [SecureProtocol.Noise];
|
||||
transportFlags: set[ServerFlags] = {}; rng = newRng();
|
||||
inTimeout: Duration = 5.minutes;
|
||||
seq[MultiAddress] = init(MultiAddress, "/ip4/127.0.0.1/tcp/0").expect(
|
||||
"valid address"); secureManagers: openArray[SecureProtocol] = [
|
||||
SecureProtocol.Noise]; transportFlags: set[ServerFlags] = {};
|
||||
rng = newRng(); inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes;
|
||||
maxConnections = MaxConnections; maxIn = -1; maxOut = -1;
|
||||
maxConnsPerPeer = MaxConnectionsPerPeer;
|
||||
nameResolver: NameResolver = nil;
|
||||
sendSignedPeerRecord = false; peerStoreCapacity = 1000): Switch" href="libp2p/builders.html#newStandardSwitch%2CopenArray%5BSecureProtocol%5D%2Cset%5BServerFlags%5D%2CDuration%2CDuration%2Cint%2Cint%2CNameResolver%2Cint">builders: newStandardSwitch(privKey = none(PrivateKey); addrs: MultiAddress |
|
||||
seq[MultiAddress] = init(MultiAddress, "/ip4/127.0.0.1/tcp/0").tryGet();
|
||||
secureManagers: openArray[SecureProtocol] = [SecureProtocol.Noise];
|
||||
transportFlags: set[ServerFlags] = {}; rng = newRng();
|
||||
inTimeout: Duration = 5.minutes;
|
||||
seq[MultiAddress] = init(MultiAddress, "/ip4/127.0.0.1/tcp/0").expect(
|
||||
"valid address"); secureManagers: openArray[SecureProtocol] = [
|
||||
SecureProtocol.Noise]; transportFlags: set[ServerFlags] = {};
|
||||
rng = newRng(); inTimeout: Duration = 5.minutes;
|
||||
outTimeout: Duration = 5.minutes;
|
||||
maxConnections = MaxConnections; maxIn = -1; maxOut = -1;
|
||||
maxConnsPerPeer = MaxConnectionsPerPeer;
|
||||
@ -3293,9 +3291,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="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="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="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="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): 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"
|
||||
@ -3389,10 +3395,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsub: onTopicSubscription(p: PubSub; topic: string; subscribed: bool)" href="libp2p/protocols/pubsub/pubsub.html#onTopicSubscription.e%2CPubSub%2Cstring%2Cbool">pubsub: onTopicSubscription(p: PubSub; topic: string; subscribed: bool)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="open" href="#open"><span>open:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: open(channel: YamuxChannel): Future[void]" href="libp2p/muxers/yamux/yamux.html#open%2CYamuxChannel">yamux: open(channel: YamuxChannel): Future[void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="Or" href="#Or"><span>Or:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="MaPatternOp.Or" href="libp2p/multiaddress.html#Or">MaPatternOp.Or</a></li>
|
||||
@ -3697,11 +3699,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"
|
||||
@ -3791,43 +3797,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"
|
||||
@ -3835,7 +3867,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>
|
||||
@ -4049,6 +4083,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: RPCHandler" href="libp2p/protocols/pubsub/pubsubpeer.html#RPCHandler">pubsubpeer: RPCHandler</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="RpcMessageQueue" href="#RpcMessageQueue"><span>RpcMessageQueue:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: RpcMessageQueue" href="libp2p/protocols/pubsub/pubsubpeer.html#RpcMessageQueue">pubsubpeer: RpcMessageQueue</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="RPCMsg" href="#RPCMsg"><span>RPCMsg:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="messages: RPCMsg" href="libp2p/protocols/pubsub/rpc/messages.html#RPCMsg">messages: RPCMsg</a></li>
|
||||
@ -4221,15 +4259,13 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="secure" href="#secure"><span>secure:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="secure: secure(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
Connection]" href="libp2p/protocols/secure/secure.html#secure.e%2CSecure%2CConnection%2Cbool%2COpt%5BPeerId%5D">secure: secure(s: Secure; conn: Connection; initiator: bool; peerId: Opt[PeerId]): Future[
|
||||
Connection]</a></li>
|
||||
data-doc-search-tag="secure: secure(s: Secure; conn: Connection; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError)]" href="libp2p/protocols/secure/secure.html#secure.e%2CSecure%2CConnection%2COpt%5BPeerId%5D">secure: secure(s: Secure; conn: Connection; peerId: Opt[PeerId]): InternalRaisesFuture[
|
||||
Connection, (CancelledError, LPStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="wstransport: secure(self: WsTransport): bool" href="libp2p/transports/wstransport.html#secure%2CWsTransport">wstransport: secure(self: WsTransport): bool</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="upgrade: secure(self: Upgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Connection]" href="libp2p/upgrademngrs/upgrade.html#secure%2CUpgrade%2CConnection%2CDirection%2COpt%5BPeerId%5D">upgrade: secure(self: Upgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Connection]</a></li>
|
||||
data-doc-search-tag="upgrade: secure(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[Connection]" href="libp2p/upgrademngrs/upgrade.html#secure%2CUpgrade%2CConnection%2COpt%5BPeerId%5D">upgrade: secure(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[Connection]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="SecureConn" href="#SecureConn"><span>SecureConn:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -4246,14 +4282,20 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<dt><a name="select" href="#select"><span>select:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): Future[string]" href="libp2p/multistream.html#select%2C%2CConnection%2Cseq%5Bstring%5D">multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): Future[string]</a></li>
|
||||
proto: seq[string]): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]" href="libp2p/multistream.html#select%2C%2CConnection%2Cseq%5Bstring%5D">multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: seq[string]): InternalRaisesFuture[string,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): Future[bool]" href="libp2p/multistream.html#select%2C%2CConnection%2Cstring">multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): Future[bool]</a></li>
|
||||
proto: string): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]" href="libp2p/multistream.html#select%2C%2CConnection%2Cstring">multistream: select(_: MultistreamSelect | type MultistreamSelect; conn: Connection;
|
||||
proto: string): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: select(m: MultistreamSelect; conn: Connection): Future[bool]" href="libp2p/multistream.html#select%2CMultistreamSelect%2CConnection">multistream: select(m: MultistreamSelect; conn: Connection): Future[bool]</a></li>
|
||||
data-doc-search-tag="multistream: select(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]" href="libp2p/multistream.html#select%2CMultistreamSelect%2CConnection">multistream: select(m: MultistreamSelect; conn: Connection): InternalRaisesFuture[bool,
|
||||
(CancelledError, LPStreamError, MultiStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="selectBest" href="#selectBest"><span>selectBest:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -4265,25 +4307,31 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="send" href="#send"><span>send:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsub: send(p: PubSub; peer: PubSubPeer; msg: RPCMsg)" href="libp2p/protocols/pubsub/pubsub.html#send%2CPubSub%2CPubSubPeer%2CRPCMsg">pubsub: send(p: PubSub; peer: PubSubPeer; msg: RPCMsg)</a></li>
|
||||
data-doc-search-tag="pubsub: send(p: PubSub; peer: PubSubPeer; msg: RPCMsg; isHighPriority: bool)" href="libp2p/protocols/pubsub/pubsub.html#send%2CPubSub%2CPubSubPeer%2CRPCMsg%2Cbool">pubsub: send(p: PubSub; peer: PubSubPeer; msg: RPCMsg; isHighPriority: bool)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: send(p: PubSubPeer; msg: RPCMsg; anonymize: bool)" href="libp2p/protocols/pubsub/pubsubpeer.html#send%2CPubSubPeer%2CRPCMsg%2Cbool">pubsubpeer: send(p: PubSubPeer; msg: RPCMsg; anonymize: bool)</a></li>
|
||||
data-doc-search-tag="pubsubpeer: send(p: PubSubPeer; msg: RPCMsg; anonymize: bool; isHighPriority: bool)" href="libp2p/protocols/pubsub/pubsubpeer.html#send%2CPubSubPeer%2CRPCMsg%2Cbool%2Cbool">pubsubpeer: send(p: PubSubPeer; msg: RPCMsg; anonymize: bool; isHighPriority: bool)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sendEncoded" href="#sendEncoded"><span>sendEncoded:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="pubsubpeer: sendEncoded(p: PubSubPeer; msg: seq[byte]): Future[void]" href="libp2p/protocols/pubsub/pubsubpeer.html#sendEncoded%2CPubSubPeer%2Cseq%5Bbyte%5D">pubsubpeer: sendEncoded(p: PubSubPeer; msg: seq[byte]): Future[void]</a></li>
|
||||
data-doc-search-tag="pubsubpeer: sendEncoded(p: PubSubPeer; msg: seq[byte]; isHighPriority: bool): Future[void]" href="libp2p/protocols/pubsub/pubsubpeer.html#sendEncoded%2CPubSubPeer%2Cseq%5Bbyte%5D%2Cbool">pubsubpeer: sendEncoded(p: PubSubPeer; msg: seq[byte]; isHighPriority: bool): Future[void]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sendHopStatus" href="#sendHopStatus"><span>sendHopStatus:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="utils: sendHopStatus(conn: Connection; code: StatusV2): Future[void]" href="libp2p/protocols/connectivity/relay/utils.html#sendHopStatus%2CConnection%2CStatusV2">utils: sendHopStatus(conn: Connection; code: StatusV2): Future[void]</a></li>
|
||||
data-doc-search-tag="utils: sendHopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/connectivity/relay/utils.html#sendHopStatus%2CConnection%2CStatusV2">utils: sendHopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sendStatus" href="#sendStatus"><span>sendStatus:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="utils: sendStatus(conn: Connection; code: StatusV1): Future[void]" href="libp2p/protocols/connectivity/relay/utils.html#sendStatus%2CConnection%2CStatusV1">utils: sendStatus(conn: Connection; code: StatusV1): Future[void]</a></li>
|
||||
data-doc-search-tag="utils: sendStatus(conn: Connection; code: StatusV1): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/connectivity/relay/utils.html#sendStatus%2CConnection%2CStatusV1">utils: sendStatus(conn: Connection; code: StatusV1): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sendStopStatus" href="#sendStopStatus"><span>sendStopStatus:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="utils: sendStopStatus(conn: Connection; code: StatusV2): Future[void]" href="libp2p/protocols/connectivity/relay/utils.html#sendStopStatus%2CConnection%2CStatusV2">utils: sendStopStatus(conn: Connection; code: StatusV2): Future[void]</a></li>
|
||||
data-doc-search-tag="utils: sendStopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]" href="libp2p/protocols/connectivity/relay/utils.html#sendStopStatus%2CConnection%2CStatusV2">utils: sendStopStatus(conn: Connection; code: StatusV2): InternalRaisesFuture[void,
|
||||
(CancelledError, LPStreamError)]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sendSubs" href="#sendSubs"><span>sendSubs:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -4305,10 +4353,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="switch: setup(self: Service; switch: Switch): Future[bool]" href="libp2p/switch.html#setup.e%2CService%2CSwitch">switch: setup(self: Service; switch: Switch): Future[bool]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="setupStreamTracker" href="#setupStreamTracker"><span>setupStreamTracker:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="lpstream: setupStreamTracker(name: string): StreamTracker" href="libp2p/stream/lpstream.html#setupStreamTracker%2Cstring">lpstream: setupStreamTracker(name: string): StreamTracker</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="Sha256" href="#Sha256"><span>Sha256:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="DigestSheme.Sha256" href="libp2p/crypto/crypto.html#Sha256">DigestSheme.Sha256</a></li>
|
||||
@ -4461,17 +4505,17 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="start" href="#start"><span>start:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: start(m: MultistreamSelect): Future[void]" href="libp2p/multistream.html#start%2CMultistreamSelect">multistream: start(m: MultistreamSelect): Future[void]</a></li>
|
||||
data-doc-search-tag="multistream: start(m: MultistreamSelect): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/multistream.html#start%2CMultistreamSelect">multistream: start(m: MultistreamSelect): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="relay: start(r: Relay): Future[void]" href="libp2p/protocols/connectivity/relay/relay.html#start.e%2CRelay">relay: start(r: Relay): Future[void]</a></li>
|
||||
data-doc-search-tag="relay: start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/protocols/connectivity/relay/relay.html#start.e%2CRelay">relay: start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rtransport: start(self: RelayTransport; ma: seq[MultiAddress]): Future[void]" href="libp2p/protocols/connectivity/relay/rtransport.html#start.e%2CRelayTransport%2Cseq%5BMultiAddress%5D">rtransport: start(self: RelayTransport; ma: seq[MultiAddress]): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="protocol: start(p: LPProtocol): Future[void]" href="libp2p/protocols/protocol.html#start.e%2CLPProtocol">protocol: start(p: LPProtocol): Future[void]</a></li>
|
||||
data-doc-search-tag="protocol: start(p: LPProtocol): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/protocols/protocol.html#start.e%2CLPProtocol">protocol: start(p: LPProtocol): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="gossipsub: start(g: GossipSub): Future[void]" href="libp2p/protocols/pubsub/gossipsub.html#start.e%2CGossipSub">gossipsub: start(g: GossipSub): Future[void]</a></li>
|
||||
data-doc-search-tag="gossipsub: start(g: GossipSub): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/protocols/pubsub/gossipsub.html#start.e%2CGossipSub">gossipsub: start(g: GossipSub): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rendezvous: start(rdv: RendezVous): Future[void]" href="libp2p/protocols/rendezvous.html#start.e%2CRendezVous">rendezvous: start(rdv: RendezVous): Future[void]</a></li>
|
||||
data-doc-search-tag="rendezvous: start(rdv: RendezVous): InternalRaisesFuture[void, (CancelledError,)]" href="libp2p/protocols/rendezvous.html#start.e%2CRendezVous">rendezvous: start(rdv: RendezVous): InternalRaisesFuture[void, (CancelledError,)]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="switch: start(s: Switch): Future[void]" href="libp2p/switch.html#start%2CSwitch">switch: start(s: Switch): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
@ -4495,17 +4539,17 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="stop" href="#stop"><span>stop:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="multistream: stop(m: MultistreamSelect): Future[void]" href="libp2p/multistream.html#stop%2CMultistreamSelect">multistream: stop(m: MultistreamSelect): Future[void]</a></li>
|
||||
data-doc-search-tag="multistream: stop(m: MultistreamSelect): InternalRaisesFuture[void, void]" href="libp2p/multistream.html#stop%2CMultistreamSelect">multistream: stop(m: MultistreamSelect): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="relay: stop(r: Relay): Future[void]" href="libp2p/protocols/connectivity/relay/relay.html#stop.e%2CRelay">relay: stop(r: Relay): Future[void]</a></li>
|
||||
data-doc-search-tag="relay: stop(r: Relay): InternalRaisesFuture[void, void]" href="libp2p/protocols/connectivity/relay/relay.html#stop.e%2CRelay">relay: stop(r: Relay): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rtransport: stop(self: RelayTransport): Future[void]" href="libp2p/protocols/connectivity/relay/rtransport.html#stop.e%2CRelayTransport">rtransport: stop(self: RelayTransport): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="protocol: stop(p: LPProtocol): Future[void]" href="libp2p/protocols/protocol.html#stop.e%2CLPProtocol">protocol: stop(p: LPProtocol): Future[void]</a></li>
|
||||
data-doc-search-tag="protocol: stop(p: LPProtocol): InternalRaisesFuture[void, void]" href="libp2p/protocols/protocol.html#stop.e%2CLPProtocol">protocol: stop(p: LPProtocol): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="gossipsub: stop(g: GossipSub): Future[void]" href="libp2p/protocols/pubsub/gossipsub.html#stop.e%2CGossipSub">gossipsub: stop(g: GossipSub): Future[void]</a></li>
|
||||
data-doc-search-tag="gossipsub: stop(g: GossipSub): InternalRaisesFuture[void, void]" href="libp2p/protocols/pubsub/gossipsub.html#stop.e%2CGossipSub">gossipsub: stop(g: GossipSub): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="rendezvous: stop(rdv: RendezVous): Future[void]" href="libp2p/protocols/rendezvous.html#stop.e%2CRendezVous">rendezvous: stop(rdv: RendezVous): Future[void]</a></li>
|
||||
data-doc-search-tag="rendezvous: stop(rdv: RendezVous): InternalRaisesFuture[void, void]" href="libp2p/protocols/rendezvous.html#stop.e%2CRendezVous">rendezvous: stop(rdv: RendezVous): InternalRaisesFuture[void, void]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="switch: stop(s: Switch): Future[void]" href="libp2p/switch.html#stop%2CSwitch">switch: stop(s: Switch): Future[void]</a></li>
|
||||
<li><a class="reference external"
|
||||
@ -4525,9 +4569,9 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="messages: StopMessageType" href="libp2p/protocols/connectivity/relay/messages.html#StopMessageType">messages: StopMessageType</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="storeMuxer" href="#storeMuxer"><span>storeMuxer:</span></a></dt><dd><ul class="simple">
|
||||
<dt><a name="stopSendNonPriorityTask" href="#stopSendNonPriorityTask"><span>stopSendNonPriorityTask:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="connmanager: storeMuxer(c: ConnManager; muxer: Muxer)" href="libp2p/connmanager.html#storeMuxer%2CConnManager%2CMuxer">connmanager: storeMuxer(c: ConnManager; muxer: Muxer)</a></li>
|
||||
data-doc-search-tag="pubsubpeer: stopSendNonPriorityTask(p: PubSubPeer)" href="libp2p/protocols/pubsub/pubsubpeer.html#stopSendNonPriorityTask%2CPubSubPeer">pubsubpeer: stopSendNonPriorityTask(p: PubSubPeer)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="StreamHandler" href="#StreamHandler"><span>StreamHandler:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -4613,10 +4657,6 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="tcptransport: TcpTransportError" href="libp2p/transports/tcptransport.html#TcpTransportError">tcptransport: TcpTransportError</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="TcpTransportTracker" href="#TcpTransportTracker"><span>TcpTransportTracker:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="tcptransport: TcpTransportTracker" href="libp2p/transports/tcptransport.html#TcpTransportTracker">tcptransport: TcpTransportTracker</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="TcpTransportTrackerName" href="#TcpTransportTrackerName"><span>TcpTransportTrackerName:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="tcptransport: TcpTransportTrackerName" href="libp2p/transports/tcptransport.html#TcpTransportTrackerName">tcptransport: TcpTransportTrackerName</a></li>
|
||||
@ -4903,13 +4943,9 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="upgrade" href="#upgrade"><span>upgrade:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="transport: upgrade(self: Transport; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/transports/transport.html#upgrade.e%2CTransport%2CConnection%2CDirection%2COpt%5BPeerId%5D">transport: upgrade(self: Transport; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
data-doc-search-tag="transport: upgrade(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/transports/transport.html#upgrade.e%2CTransport%2CConnection%2COpt%5BPeerId%5D">transport: upgrade(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="muxedupgrade: upgrade(self: MuxedUpgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/upgrademngrs/muxedupgrade.html#upgrade.e%2CMuxedUpgrade%2CConnection%2CDirection%2COpt%5BPeerId%5D">muxedupgrade: upgrade(self: MuxedUpgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
data-doc-search-tag="muxedupgrade: upgrade(self: MuxedUpgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/upgrademngrs/muxedupgrade.html#upgrade.e%2CMuxedUpgrade%2CConnection%2COpt%5BPeerId%5D">muxedupgrade: upgrade(self: MuxedUpgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="Upgrade" href="#Upgrade"><span>Upgrade:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -4917,9 +4953,7 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
</ul></dd>
|
||||
<dt><a name="upgrade" href="#upgrade"><span>upgrade:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="upgrade: upgrade(self: Upgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/upgrademngrs/upgrade.html#upgrade.e%2CUpgrade%2CConnection%2CDirection%2COpt%5BPeerId%5D">upgrade: upgrade(self: Upgrade; conn: Connection; direction: Direction;
|
||||
peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
data-doc-search-tag="upgrade: upgrade(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]" href="libp2p/upgrademngrs/upgrade.html#upgrade.e%2CUpgrade%2CConnection%2COpt%5BPeerId%5D">upgrade: upgrade(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[Muxer]</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="UpgradeFailedError" href="#UpgradeFailedError"><span>UpgradeFailedError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
@ -5069,6 +5103,12 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="builders: withNoise(b: SwitchBuilder): SwitchBuilder" href="libp2p/builders.html#withNoise%2CSwitchBuilder">builders: withNoise(b: SwitchBuilder): SwitchBuilder</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="withObservedAddrManager" href="#withObservedAddrManager"><span>withObservedAddrManager:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="builders: withObservedAddrManager(b: SwitchBuilder;
|
||||
observedAddrManager: ObservedAddrManager): SwitchBuilder" href="libp2p/builders.html#withObservedAddrManager%2CSwitchBuilder%2CObservedAddrManager">builders: withObservedAddrManager(b: SwitchBuilder;
|
||||
observedAddrManager: ObservedAddrManager): SwitchBuilder</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="withPeerStats" href="#withPeerStats"><span>withPeerStats:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="scoring: withPeerStats(g: GossipSub; peerId: PeerId;
|
||||
@ -5165,7 +5205,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"
|
||||
@ -5177,7 +5219,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"
|
||||
@ -5195,17 +5239,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"
|
||||
@ -5213,9 +5267,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"
|
||||
@ -5224,12 +5282,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"
|
||||
@ -5291,6 +5351,10 @@ window.addEventListener('DOMContentLoaded', main);
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: YamuxCodec" href="libp2p/muxers/yamux/yamux.html#YamuxCodec">yamux: YamuxCodec</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="YamuxDefaultWindowSize" href="#YamuxDefaultWindowSize"><span>YamuxDefaultWindowSize:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: YamuxDefaultWindowSize" href="libp2p/muxers/yamux/yamux.html#YamuxDefaultWindowSize">yamux: YamuxDefaultWindowSize</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="YamuxError" href="#YamuxError"><span>YamuxError:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="yamux: YamuxError" href="libp2p/muxers/yamux/yamux.html#YamuxError">yamux: YamuxError</a></li>
|
||||
@ -5316,7 +5380,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-19 14:51:31 UTC</small>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 14:52:58 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user