2024-02-01 19:07:40 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8" ?>
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<!-- This file is generated by Nim. -->
|
|
|
|
<html xmlns="http://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">
|
|
|
|
|
|
|
|
<!-- 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=">
|
|
|
|
|
|
|
|
<!-- 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'/>
|
|
|
|
|
|
|
|
<!-- CSS -->
|
|
|
|
<title>libp2p/muxers/yamux/yamux</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../nimdoc.out.css">
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../../dochack.js"></script>
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
function main() {
|
|
|
|
var pragmaDots = document.getElementsByClassName("pragmadots");
|
|
|
|
for (var i = 0; i < pragmaDots.length; i++) {
|
|
|
|
pragmaDots[i].onclick = function(event) {
|
|
|
|
// Hide tease
|
|
|
|
event.target.parentNode.style.display = "none";
|
|
|
|
// Show actual
|
|
|
|
event.target.parentNode.nextElementSibling.style.display = "inline";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function switchTheme(e) {
|
|
|
|
if (e.target.checked) {
|
|
|
|
document.documentElement.setAttribute('data-theme', 'dark');
|
|
|
|
localStorage.setItem('theme', 'dark');
|
|
|
|
} else {
|
|
|
|
document.documentElement.setAttribute('data-theme', 'light');
|
|
|
|
localStorage.setItem('theme', 'light');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
|
|
|
if (toggleSwitch !== null) {
|
|
|
|
toggleSwitch.addEventListener('change', switchTheme, false);
|
|
|
|
}
|
|
|
|
|
|
|
|
var currentTheme = localStorage.getItem('theme');
|
|
|
|
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
|
|
|
currentTheme = 'dark';
|
|
|
|
}
|
|
|
|
if (currentTheme) {
|
|
|
|
document.documentElement.setAttribute('data-theme', currentTheme);
|
|
|
|
|
|
|
|
if (currentTheme === 'dark' && toggleSwitch !== null) {
|
|
|
|
toggleSwitch.checked = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
window.addEventListener('DOMContentLoaded', main);
|
|
|
|
</script>
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="document" id="documentId">
|
|
|
|
<div class="container">
|
|
|
|
<h1 class="title">libp2p/muxers/yamux/yamux</h1>
|
|
|
|
<div class="row">
|
|
|
|
<div class="three columns">
|
|
|
|
<div class="theme-switch-wrapper">
|
|
|
|
<label class="theme-switch" for="checkbox">
|
|
|
|
<input type="checkbox" id="checkbox" />
|
|
|
|
<div class="slider round"></div>
|
|
|
|
</label>
|
|
|
|
<em>Dark Mode</em>
|
|
|
|
</div>
|
|
|
|
<div id="global-links">
|
|
|
|
<ul class="simple">
|
|
|
|
<li>
|
|
|
|
<a href="../../../theindex.html">Index</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="searchInputDiv">
|
|
|
|
Search: <input type="text" 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>
|
|
|
|
<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>
|
|
|
|
<ul class="simple simple-toc-section">
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
|
|
|
<ul class="simple simple-toc-section">
|
|
|
|
<li><a class="reference" href="#Yamux"
|
|
|
|
title="Yamux = ref object of Muxer
|
|
|
|
channels: Table[uint32, YamuxChannel]
|
|
|
|
flushed: Table[uint32, int]
|
|
|
|
currentId: uint32
|
|
|
|
isClosed: bool
|
|
|
|
maxChannCount: int
|
|
|
|
windowSize: int
|
|
|
|
maxSendQueueSize: int">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
|
|
|
|
isSending: bool
|
|
|
|
sendQueue: seq[ToSend]
|
|
|
|
recvQueue: seq[byte]
|
|
|
|
isReset: bool
|
|
|
|
remoteReset: bool
|
|
|
|
closedRemotely: Future[void]
|
|
|
|
closedLocally: bool
|
|
|
|
receivedData: AsyncEvent
|
|
|
|
returnedEof: bool">YamuxChannel</a></li>
|
|
|
|
<li><a class="reference" href="#YamuxError"
|
|
|
|
title="YamuxError = object of CatchableError">YamuxError</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
|
|
<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%2Cint%2Cint"
|
|
|
|
title="new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
|
|
|
windowSize: int = YamuxDefaultWindowSize;
|
|
|
|
maxSendQueueSize: int = MaxSendQueueSize): T:type">new(T: type[Yamux]; conn: Connection; maxChannCount: int = MaxChannelCount;
|
|
|
|
windowSize: int = YamuxDefaultWindowSize;
|
|
|
|
maxSendQueueSize: int = MaxSendQueueSize): 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>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<ul class="simple nested-toc-section">setMaxRecvWindow
|
|
|
|
<li><a class="reference" href="#setMaxRecvWindow%2CYamuxChannel%2Cint"
|
|
|
|
title="setMaxRecvWindow(channel: YamuxChannel; maxRecvWindow: int)">setMaxRecvWindow(channel: YamuxChannel; maxRecvWindow: int)</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<ul class="simple nested-toc-section">getStreams
|
|
|
|
<li><a class="reference" href="#getStreams.e%2CYamux"
|
|
|
|
title="getStreams(m: Yamux): seq[Connection]">getStreams(m: Yamux): seq[Connection]</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<ul class="simple nested-toc-section">getWrapped
|
|
|
|
<li><a class="reference" href="#getWrapped.e%2CYamuxChannel"
|
|
|
|
title="getWrapped(channel: YamuxChannel): Connection">getWrapped(channel: YamuxChannel): Connection</a></li>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
|
|
|
|
<ul class="simple simple-toc-section">
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L1"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
<div class="nine columns" id="content">
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
|
|
|
|
<p class="module-desc"></p>
|
|
|
|
<div class="section" id="6">
|
|
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
|
|
<dl class="item">
|
|
|
|
<a class="reference external" href="../muxer.html">../muxer</a>, <a class="reference external" href="../../stream/connection.html">../../stream/connection</a>
|
|
|
|
</dl></div>
|
|
|
|
<div class="section" id="7">
|
|
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
|
|
<dl class="item">
|
|
|
|
<div id="Yamux" class="tohide">
|
|
|
|
<dt><pre><a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../muxer.html#Muxer"><span class="Identifier">Muxer</span></a>
|
|
|
|
<span class="Identifier">channels</span><span class="Other">:</span> <span class="Identifier">Table</span><span class="Other">[</span><span class="Identifier">uint32</span><span class="Other">,</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">]</span>
|
|
|
|
<span class="Identifier">flushed</span><span class="Other">:</span> <span class="Identifier">Table</span><span class="Other">[</span><span class="Identifier">uint32</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span>
|
|
|
|
<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>
|
|
|
|
</pre></dt>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L371"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L371" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="YamuxChannel" class="tohide">
|
|
|
|
<dt><pre><a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>
|
|
|
|
<span class="Identifier">id</span><span class="Other">:</span> <span class="Identifier">uint32</span>
|
|
|
|
<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>
|
|
|
|
<span class="Identifier">isSending</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
|
|
|
<span class="Identifier">sendQueue</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">ToSend</span><span class="Other">]</span>
|
|
|
|
<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">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>
|
|
|
|
</pre></dt>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L142"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</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>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L37"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</dl></div>
|
|
|
|
<div class="section" id="10">
|
|
|
|
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
|
|
|
<dl class="item">
|
|
|
|
<div id="YamuxCodec" class="tohide">
|
|
|
|
<dt><pre><a href="yamux.html#YamuxCodec"><span class="Identifier">YamuxCodec</span></a> <span class="Other">=</span> <span class="StringLit">"/yamux/1.0.0"</span></pre></dt>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L23"
|
|
|
|
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/improve-docs/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>
|
|
|
|
|
|
|
|
</dl></div>
|
|
|
|
<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,int,int" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctype%5BYamux%5D%2CConnection%2Cint%2Cint%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="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="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/improve-docs/libp2p/muxers/yamux/yamux.nim#L546"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L546" 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 class="Identifier">stackTrace</span><span class="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/improve-docs/libp2p/muxers/yamux/yamux.nim#L358"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L358" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="setMaxRecvWindow,YamuxChannel,int" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#setMaxRecvWindow%2CYamuxChannel%2Cint"><span class="Identifier">setMaxRecvWindow</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">maxRecvWindow</span><span class="Other">:</span> <span class="Identifier">int</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>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L282"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L282" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</dl></div>
|
|
|
|
<div class="section" id="14">
|
|
|
|
<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>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L427"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L427" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="closeImpl.e,YamuxChannel" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CYamuxChannel"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">channel</span><span class="Other">:</span> <a href="yamux.html#YamuxChannel"><span class="Identifier">YamuxChannel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
|
|
|
<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/improve-docs/libp2p/muxers/yamux/yamux.nim#L193"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L193" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="getStreams.e,Yamux" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">method</span> <a href="#getStreams.e%2CYamux"><span class="Identifier">getStreams</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">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/improve-docs/libp2p/muxers/yamux/yamux.nim#L530"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L530" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="getWrapped.e,YamuxChannel" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">method</span> <a href="#getWrapped.e%2CYamuxChannel"><span class="Identifier">getWrapped</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> <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/improve-docs/libp2p/muxers/yamux/yamux.nim#L368"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L368" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="handle.e,Yamux" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CYamux"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
|
|
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><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/improve-docs/libp2p/muxers/yamux/yamux.nim#L453"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L453" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
<div id="newStream.e,Yamux,string,bool" class="tohide">
|
|
|
|
<dt><pre><span class="Keyword">method</span> <a href="#newStream.e%2CYamux%2Cstring%2Cbool"><span class="Identifier">newStream</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="yamux.html#Yamux"><span class="Identifier">Yamux</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">lazy</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
|
|
|
<a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><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/improve-docs/libp2p/muxers/yamux/yamux.nim#L536"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L536" 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>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L244"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L244" 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>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/improve-docs/libp2p/muxers/yamux/yamux.nim#L342"
|
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/muxers/yamux/yamux.nim#L342" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</dl></div>
|
|
|
|
<div class="section" id="19">
|
|
|
|
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
|
|
|
<dl class="item">
|
|
|
|
<a href="../muxer.html#formatItIMPL.t,Muxer"><span class="Identifier">formatItIMPL</span></a>, <a href="../muxer.html#new,typedesc[MuxerProvider],MuxerConstructor,string"><span class="Identifier">new</span></a>, <a href="../muxer.html#MuxerProvider"><span class="Identifier">MuxerProvider</span></a>, <a href="../muxer.html#close.e,Muxer"><span class="Identifier">close</span></a>, <a href="../muxer.html#shortLog,Muxer"><span class="Identifier">shortLog</span></a>, <a href="../muxer.html#MuxerError"><span class="Identifier">MuxerError</span></a>, <a href="../muxer.html#MuxerConstructor"><span class="Identifier">MuxerConstructor</span></a>, <a href="../muxer.html#Muxer"><span class="Identifier">Muxer</span></a>, <a href="../muxer.html#newStream.e,Muxer,string,bool"><span class="Identifier">newStream</span></a>, <a href="../muxer.html#DefaultChanTimeout"><span class="Identifier">DefaultChanTimeout</span></a>, <a href="../muxer.html#getStreams.e,Muxer"><span class="Identifier">getStreams</span></a>, <a href="../muxer.html#MuxerHandler"><span class="Identifier">MuxerHandler</span></a>, <a href="../muxer.html#StreamHandler"><span class="Identifier">StreamHandler</span></a>, <a href="../muxer.html#TooManyChannels"><span class="Identifier">TooManyChannels</span></a>, <a href="../muxer.html#handle.e,Muxer"><span class="Identifier">handle</span></a>
|
|
|
|
</dl></div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="row">
|
|
|
|
<div class="twelve-columns footer">
|
|
|
|
<span class="nim-sprite"></span>
|
|
|
|
<br/>
|
2024-02-05 14:51:56 +00:00
|
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-05 14:51:49 UTC</small>
|
2024-02-01 19:07:40 +00:00
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|