status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-libp2p/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.html

514 lines
71 KiB
HTML
Raw Normal View History

update docs for rate-limit-fixes
2023-10-13 16:28:57 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>libp2p/muxers/mplex/lpchannel</title>
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="../../../nimdoc.out.css">
<!-- JS -->
<script type="text/javascript" src="../../../dochack.js"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">libp2p/muxers/mplex/lpchannel</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple">
<li><a id="indexLink" href="../../../theindex.html">Index</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput" onkeyup="search()"/>
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#LPChannel" title="LPChannel = ref object of BufferStream
id*: uint64
name*: string
conn*: Connection
initiator*: bool
isOpen*: bool
closedLocal*: bool
remoteReset*: bool
localReset*: bool
msgCode*: MessageType
closeCode*: MessageType
resetCode*: MessageType
writes*: int">LPChannel</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#LPChannelTrackerName" title="LPChannelTrackerName = &quot;LPChannel&quot;">LPChannelTrackerName</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2CtypeLPChannel%2Cuint64%2CConnection%2Cbool%2Cstring%2CDuration" title="init(L: type LPChannel; id: uint64; conn: Connection; initiator: bool;
name: string = &quot;&quot;; timeout: Duration = DefaultChanTimeout): LPChannel">init(L: type LPChannel; id: uint64; conn: Connection; initiator: bool;
name: string = &quot;&quot;; timeout: Duration = DefaultChanTimeout): LPChannel</a></li>
</ul>
<ul class="simple nested-toc-section">open
<li><a class="reference" href="#open%2CLPChannel" title="open(s: LPChannel)">open(s: LPChannel)</a></li>
</ul>
<ul class="simple nested-toc-section">reset
<li><a class="reference" href="#reset%2CLPChannel" title="reset(s: LPChannel)">reset(s: LPChannel)</a></li>
</ul>
<ul class="simple nested-toc-section">shortLog
<li><a class="reference" href="#shortLog%2CLPChannel" title="shortLog(s: LPChannel): auto">shortLog(s: LPChannel): auto</a></li>
</ul>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#14" id="64">Methods</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">close
<li><a class="reference" href="#close.e%2CLPChannel" title="close(s: LPChannel)">close(s: LPChannel)</a></li>
</ul>
<ul class="simple nested-toc-section">closed
<li><a class="reference" href="#closed.e%2CLPChannel" title="closed(s: LPChannel): bool">closed(s: LPChannel): bool</a></li>
</ul>
<ul class="simple nested-toc-section">getWrapped
<li><a class="reference" href="#getWrapped.e%2CLPChannel" title="getWrapped(s: LPChannel): Connection">getWrapped(s: LPChannel): Connection</a></li>
</ul>
<ul class="simple nested-toc-section">initStream
<li><a class="reference" href="#initStream.e%2CLPChannel" title="initStream(s: LPChannel)">initStream(s: LPChannel)</a></li>
</ul>
<ul class="simple nested-toc-section">readOnce
<li><a class="reference" href="#readOnce.e%2CLPChannel%2Cpointer%2Cint" title="readOnce(s: LPChannel; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: LPChannel; pbytes: pointer; nbytes: int): Future[int]</a></li>
</ul>
<ul class="simple nested-toc-section">write
<li><a class="reference" href="#write.e%2CLPChannel%2Cseq%5Bbyte%5D" title="write(s: LPChannel; msg: seq[byte]): Future[void]">write(s: LPChannel; msg: seq[byte]): Future[void]</a></li>
</ul>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">formatItIMPL
<li><a class="reference" href="#formatItIMPL.t%2CLPChannel" title="formatItIMPL(it: LPChannel): auto">formatItIMPL(it: LPChannel): auto</a></li>
</ul>
</ul>
</details>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc"><pre>Channel half-closed states
| State | Closed local | Closed remote
|=============================================
| Read | Yes (until EOF) | No
| Write | No | Yes
Channels are considered fully closed when both outgoing and incoming
directions are closed and when the reader of the channel has read the
EOF marker</pre>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="coder.html">coder</a>, <a class="reference external" href="../muxer.html">../muxer</a>, <a class="reference external" href="../../stream/bufferstream.html">../../stream/bufferstream</a>, <a class="reference external" href="../../stream/connection.html">../../stream/connection</a>, <a class="reference external" href="../../stream/streamseq.html">../../stream/streamseq</a>, <a class="reference external" href="../../peerinfo.html">../../peerinfo</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="LPChannel" class="tohide">
<dt><pre><a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../../stream/bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a>
<span class="Identifier">id</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
<span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
<span class="Identifier">conn</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>
<span class="Identifier">initiator</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">isOpen</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">closedLocal</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">remoteReset</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">localReset</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">msgCode</span><span class="Operator">*</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a>
<span class="Identifier">closeCode</span><span class="Operator">*</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a>
<span class="Identifier">resetCode</span><span class="Operator">*</span><span class="Other">:</span> <a href="coder.html#MessageType"><span class="Identifier">MessageType</span></a>
<span class="Identifier">writes</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
</pre></dt>
<dd>
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L51" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L51" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="10">
<h1><a class="toc-backref" href="#10">Consts</a></h1>
<dl class="item">
<div id="LPChannelTrackerName" class="tohide">
<dt><pre><a href="lpchannel.html#LPChannelTrackerName"><span class="Identifier">LPChannelTrackerName</span></a> <span class="Other">=</span> <span class="StringLit">&quot;LPChannel&quot;</span></pre></dt>
<dd>
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L48" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L48" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="init-procs-all">
<div id="init,typeLPChannel,uint64,Connection,bool,string,Duration" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CtypeLPChannel%2Cuint64%2CConnection%2Cbool%2Cstring%2CDuration"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">type</span> <span class="Identifier">LPChannel</span><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">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">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <span class="Identifier">Duration</span> <span class="Other">=</span> <span class="Identifier">DefaultChanTimeout</span><span class="Other">)</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</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>.}</pre></dt>
<dd>
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L278" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L278" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="open-procs-all">
<div id="open,LPChannel" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#open%2CLPChannel"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span> {.<span class="Identifier">async</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 class="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L76" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L76" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="reset-procs-all">
<div id="reset,LPChannel" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#reset%2CLPChannel"><span class="Identifier">reset</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span> {.<span class="Identifier">async</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 class="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L98" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L98" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="shortLog-procs-all">
<div id="shortLog,LPChannel" class="tohide">
<dt><pre><span class="Keyword">func</span> <a href="#shortLog%2CLPChannel"><span class="Identifier">shortLog</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</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 class="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L65" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L65" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
<div class="section" id="14">
<h1><a class="toc-backref" href="#14">Methods</a></h1>
<dl class="item">
<div id="close-methods-all">
<div id="close.e,LPChannel" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#close.e%2CLPChannel"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span> {.<span class="Identifier">async</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Close channel for writing - a message will be sent to the other peer informing them that the channel is closed and that we're waiting for their acknowledgement.
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="closed-methods-all">
<div id="closed.e,LPChannel" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#closed.e%2CLPChannel"><span class="Identifier">closed</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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 class="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L89" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L89" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="getWrapped-methods-all">
<div id="getWrapped.e,LPChannel" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#getWrapped.e%2CLPChannel"><span class="Identifier">getWrapped</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</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 class="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L276" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L276" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="initStream-methods-all">
<div id="initStream.e,LPChannel" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CLPChannel"><span class="Identifier">initStream</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</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="Other">,</span> <span class="Identifier">forbids</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/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="readOnce-methods-all">
<div id="readOnce.e,LPChannel,pointer,int" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CLPChannel%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</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">async</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="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Mplex relies on reading being done regularly from every channel, or all channels are blocked - in particular, this means that reading from one channel must not be done from within a callback / read handler of another or the reads will lock each other.
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L163" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L163" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="write-methods-all">
<div id="write.e,LPChannel,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#write.e%2CLPChannel%2Cseq%5Bbyte%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Write to mplex channel - there may be up to MaxWrite concurrent writes pending after which the peer is disconnected
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L258" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L258" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
<div class="section" id="18">
<h1><a class="toc-backref" href="#18">Templates</a></h1>
<dl class="item">
<div id="formatItIMPL-templates-all">
<div id="formatItIMPL.t,LPChannel" class="tohide">
<dt><pre><span class="Keyword">template</span> <a href="#formatItIMPL.t%2CLPChannel"><span class="Identifier">formatItIMPL</span></a><span class="Other">(</span><span class="Identifier">it</span><span class="Other">:</span> <a href="lpchannel.html#LPChannel"><span class="Identifier">LPChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</span></pre></dt>
<dd>
<a href="https://github.com/status-im/nim-libp2p/tree/rate-limit-fixes/libp2p/muxers/mplex/lpchannel.nim#L74" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/mplex/lpchannel.nim#L74" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="../../stream/lpstream.html#newLPStreamWriteError,ref.CatchableError"><span class="Identifier">newLPStreamWriteError</span></a>, <a href="../../multiaddress.html#DNS_OR_IP"><span class="Identifier">DNS_OR_IP</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoHeader"><span class="Identifier">ProtoHeader</span></a>, <a href="../../utility.html#shortLog,string"><span class="Identifier">shortLog</span></a>, <a href="../../signed_envelope.html#init,typedesc[SignedPayload[T]],PrivateKey,T"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#random,typedesc[KeyPair],HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../multiaddress.html#UDP_DNS"><span class="Identifier">UDP_DNS</span></a>, <a href="../../crypto/crypto.html#$"><span class="Identifier">$</span></a>, <a href="../../protobuf/minprotobuf.html#getProtoHeader.t,int,ProtoFieldKind"><span class="Identifier">getProtoHeader</span></a>, <a href="../../multiaddress.html#MaError"><span class="Identifier">MaError</span></a>, <a href="../../crypto/ecnist.html#ephemeral,string,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="../../multiaddress.html#MaPatternOp"><span class="Identifier">MaPatternOp</span></a>, <a href="../../multiaddress.html#WS_DNS"><span class="Identifier">WS_DNS</span></a>, <a href="../../vbuffer.html#initVBuffer,seq[byte],int"><span class="Identifier">initVBuffer</span></a>, <a href="../../protobuf/minprotobuf.html#getProtoHeader.t,ProtoField"><span class="Identifier">getProtoHeader</span></a>, <a href="../../stream/lpstream.html#MaxSizeError"><span class="Identifier">MaxSizeError</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoFlags"><span class="Identifier">ProtoFlags</span></a>, <a href="../../protobuf/minprotobuf.html#getLen.t,ProtoBuffer"><span class="Identifier">getLen</span></a>, <a href="../../crypto/ecnist.html#ECDHEScheme"><span class="Identifier">ECDHEScheme</span></a>, <a href="../../peerinfo.html#shortLog,PeerInfo"><span class="Identifier">shortLog</span></a>, <a href="../../peerid.html#init,PeerId,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],"><span class="Identifier">init</span></a>, <a href="../../stream/lpstream.html#closed.e,LPStream"><span class="Identifier">closed</span></a>, <a href="../../multiaddress.html#[],MultiAddress,MultiCodec"><span class="Identifier">[]</span></a>, <a href="../../signed_envelope.html#decode,typedesc[SignedPayload[T]],seq[byte]"><span class="Identifier">decode</span></a>, <a href="../../crypto/crypto.html#macOpenArray.t,Secret,int"><span class="Identifier">macOpenArray</span></a>, <a href="../../crypto/crypto.html#random,typedesc[KeyPair],PKScheme,HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],MultiCodec,PeerId"><span class="Identifier">init</span></a>, <a href="../../vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a>, <a href="../../crypto/crypto.html#Secret"><span class="Identifier">Secret</span></a>, <a href="../../vbuffer.html#peekVarint,VBuffer,LPSomeUVarint"><span class="Identifier">peekVarint</span></a>, <a href="../../peerid.html#random,typedesc[PeerId]"><span class="Identifier">random</span></a>, <a href="../../vbuffer.html#$,VBuffer"><span class="Identifier">$</span></a>, <a href="../../multiaddress.html#validate,MultiAddress"><span class="Identifier">validate</span></a>, <a href="../../multiaddress.html#mapOr,varargs[MaPattern]"><span class="Identifier">mapOr</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],ValidIpAddress,IpTransportProtocol,Port"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#bytes,MultiAddress"><span class="Identifier">bytes</span></a>, <a href="../../peerid.html#maxInlineKeyLength"><span class="Identifier">maxInlineKeyLength</span></a>, <a href="../../multiaddress.html#TranscoderDNS"><span class="Identifier">TranscoderDNS</span></a>, <a href="../../multiaddress.html#QUIC"><
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2023-10-13 16:28:53 UTC</small>
</div>
</div>
</div>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
</body>
</html>