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/message-id-mem/libp2p/protocols/connectivity/relay/relay.html

579 lines
37 KiB
HTML
Raw Normal View History

update docs for message-id-mem
2024-03-19 14:51:38 +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/protocols/connectivity/relay/relay</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/protocols/connectivity/relay/relay</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>
&nbsp;&nbsp;&nbsp; <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>
&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>
<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="#Relay"
title="Relay = ref object of LPProtocol
switch*: Switch
peerCount: CountTable[PeerId]
maxCircuit*: int
maxCircuitPerPeer*: int
msgSize*: int
isCircuitRelayV1*: bool
streamCount: int
rsvp: Table[PeerId, DateTime]
reservationLoop: Future[void]
reservationTTL*: times.Duration
heartbeatSleepTime*: uint32
limit*: Limit">Relay</a></li>
<li><a class="reference" href="#RelayV2Error"
title="RelayV2Error = object of LPError">RelayV2Error</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="#DefaultHeartbeatSleepTime"
title="DefaultHeartbeatSleepTime = 1">DefaultHeartbeatSleepTime</a></li>
<li><a class="reference" href="#DefaultLimitData"
title="DefaultLimitData = 131072">DefaultLimitData</a></li>
<li><a class="reference" href="#DefaultLimitDuration"
title="DefaultLimitDuration = 120">DefaultLimitDuration</a></li>
<li><a class="reference" href="#DefaultReservationTTL"
title="DefaultReservationTTL = (seconds: 3600, nanosecond: 0)">DefaultReservationTTL</a></li>
<li><a class="reference" href="#MaxCircuit"
title="MaxCircuit = 128">MaxCircuit</a></li>
<li><a class="reference" href="#MaxCircuitPerPeer"
title="MaxCircuitPerPeer = 16">MaxCircuitPerPeer</a></li>
<li><a class="reference" href="#RelayMsgSize"
title="RelayMsgSize = 4096">RelayMsgSize</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">handleHop
<li><a class="reference" href="#handleHop%2CRelay%2CConnection%2CRelayMessage"
title="handleHop(r: Relay; connSrc: Connection; msg: RelayMessage): Future[void]">handleHop(r: Relay; connSrc: Connection; msg: RelayMessage): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">handleHopStreamV2
<li><a class="reference" href="#handleHopStreamV2%2CRelay%2CConnection"
title="handleHopStreamV2(r: Relay; conn: Connection): Future[void]">handleHopStreamV2(r: Relay; conn: Connection): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">isRelayed
<li><a class="reference" href="#isRelayed%2CConnection"
title="isRelayed(conn: Connection): bool">isRelayed(conn: Connection): bool</a></li>
</ul>
<ul class="simple nested-toc-section">new
<li><a class="reference" href="#new%2Ctypedesc%5BRelay%5D%2Cuint32%2Cuint64%2Cuint32%2Cint%2Cint%2Cint%2Cbool"
title="new(T: typedesc[Relay]; reservationTTL: times.Duration = DefaultReservationTTL;
limitDuration: uint32 = DefaultLimitDuration;
limitData: uint64 = DefaultLimitData;
heartbeatSleepTime: uint32 = DefaultHeartbeatSleepTime;
maxCircuit: int = MaxCircuit; maxCircuitPerPeer: int = MaxCircuitPerPeer;
msgSize: int = RelayMsgSize; circuitRelayV1: bool = false): T:type">new(T: typedesc[Relay]; reservationTTL: times.Duration = DefaultReservationTTL;
limitDuration: uint32 = DefaultLimitDuration;
limitData: uint64 = DefaultLimitData;
heartbeatSleepTime: uint32 = DefaultHeartbeatSleepTime;
maxCircuit: int = MaxCircuit; maxCircuitPerPeer: int = MaxCircuitPerPeer;
msgSize: int = RelayMsgSize; circuitRelayV1: bool = false): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">setup
<li><a class="reference" href="#setup%2CRelay%2CSwitch"
title="setup(r: Relay; switch: Switch)">setup(r: Relay; switch: Switch)</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">start
<li><a class="reference" href="#start.e%2CRelay"
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
title="start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]">start(r: Relay): InternalRaisesFuture[void, (CancelledError,)]</a></li>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
</ul>
<ul class="simple nested-toc-section">stop
<li><a class="reference" href="#stop.e%2CRelay"
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
title="stop(r: Relay): InternalRaisesFuture[void, void]">stop(r: Relay): InternalRaisesFuture[void, void]</a></li>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.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="messages.html">messages</a>, <a class="reference external" href="rconn.html">rconn</a>, <a class="reference external" href="utils.html">utils</a>, <a class="reference external" href="../../../peerinfo.html">../../../peerinfo</a>, <a class="reference external" href="../../../switch.html">../../../switch</a>, <a class="reference external" href="../../../multiaddress.html">../../../multiaddress</a>, <a class="reference external" href="../../../multicodec.html">../../../multicodec</a>, <a class="reference external" href="../../../stream/connection.html">../../../stream/connection</a>, <a class="reference external" href="../../protocol.html">../../protocol</a>, <a class="reference external" href="../../../errors.html">../../../errors</a>, <a class="reference external" href="../../../utils/heartbeat.html">../../../utils/heartbeat</a>, <a class="reference external" href="../../../signed_envelope.html">../../../signed_envelope</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="Relay" class="tohide">
<dt><pre><a href="relay.html#Relay"><span class="Identifier">Relay</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../../protocol.html#LPProtocol"><span class="Identifier">LPProtocol</span></a>
<span class="Identifier">switch</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../../transports/transport.html#Switch"><span class="Identifier">Switch</span></a>
<span class="Identifier">peerCount</span><span class="Other">:</span> <span class="Identifier">CountTable</span><span class="Other">[</span><a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span>
<span class="Identifier">maxCircuit</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">maxCircuitPerPeer</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">msgSize</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">isCircuitRelayV1</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">streamCount</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">rsvp</span><span class="Other">:</span> <span class="Identifier">Table</span><span class="Other">[</span><a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">,</span> <span class="Identifier">DateTime</span><span class="Other">]</span>
<span class="Identifier">reservationLoop</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">reservationTTL</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Duration</span>
<span class="Identifier">heartbeatSleepTime</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint32</span>
<span class="Identifier">limit</span><span class="Operator">*</span><span class="Other">:</span> <a href="messages.html#Limit"><span class="Identifier">Limit</span></a>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L58"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayV2Error" class="tohide">
<dt><pre><a href="relay.html#RelayV2Error"><span class="Identifier">RelayV2Error</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L52"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L52" 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="DefaultHeartbeatSleepTime" class="tohide">
<dt><pre><a href="relay.html#DefaultHeartbeatSleepTime"><span class="Identifier">DefaultHeartbeatSleepTime</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L44"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="DefaultLimitData" class="tohide">
<dt><pre><a href="relay.html#DefaultLimitData"><span class="Identifier">DefaultLimitData</span></a> <span class="Other">=</span> <span class="DecNumber">131072</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L43"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="DefaultLimitDuration" class="tohide">
<dt><pre><a href="relay.html#DefaultLimitDuration"><span class="Identifier">DefaultLimitDuration</span></a> <span class="Other">=</span> <span class="DecNumber">120</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L42"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="DefaultReservationTTL" class="tohide">
<dt><pre><a href="relay.html#DefaultReservationTTL"><span class="Identifier">DefaultReservationTTL</span></a> <span class="Other">=</span> <span class="Other">(</span><span class="Identifier">seconds</span><span class="Other">:</span> <span class="DecNumber">3600</span><span class="Other">,</span> <span class="Identifier">nanosecond</span><span class="Other">:</span> <span class="DecNumber">0</span><span class="Other">)</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L41"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MaxCircuit" class="tohide">
<dt><pre><a href="relay.html#MaxCircuit"><span class="Identifier">MaxCircuit</span></a> <span class="Other">=</span> <span class="DecNumber">128</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L45"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MaxCircuitPerPeer" class="tohide">
<dt><pre><a href="relay.html#MaxCircuitPerPeer"><span class="Identifier">MaxCircuitPerPeer</span></a> <span class="Other">=</span> <span class="DecNumber">16</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L46"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayMsgSize" class="tohide">
<dt><pre><a href="relay.html#RelayMsgSize"><span class="Identifier">RelayMsgSize</span></a> <span class="Other">=</span> <span class="DecNumber">4096</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L40"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L40" 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="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> {.
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
<span class="Identifier">stackTrace</span><span class="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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
<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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L217"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L217" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleHopStreamV2,Relay,Connection" class="tohide">
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
<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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
<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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L203"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L203" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="isRelayed,Connection" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#isRelayed%2CConnection"><span class="Identifier">isRelayed</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">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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L100"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="new,typedesc[Relay],uint32,uint64,uint32,int,int,int,bool" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BRelay%5D%2Cuint32%2Cuint64%2Cuint32%2Cint%2Cint%2Cint%2Cbool"><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="relay.html#Relay"><span class="Identifier">Relay</span></a><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">reservationTTL</span><span class="Other">:</span> <span class="Identifier">times</span><span class="Other">.</span><span class="Identifier">Duration</span> <span class="Other">=</span> <span class="Identifier">DefaultReservationTTL</span><span class="Other">;</span>
<span class="Identifier">limitDuration</span><span class="Other">:</span> <span class="Identifier">uint32</span> <span class="Other">=</span> <span class="Identifier">DefaultLimitDuration</span><span class="Other">;</span>
<span class="Identifier">limitData</span><span class="Other">:</span> <span class="Identifier">uint64</span> <span class="Other">=</span> <span class="Identifier">DefaultLimitData</span><span class="Other">;</span>
<span class="Identifier">heartbeatSleepTime</span><span class="Other">:</span> <span class="Identifier">uint32</span> <span class="Other">=</span> <span class="Identifier">DefaultHeartbeatSleepTime</span><span class="Other">;</span>
<span class="Identifier">maxCircuit</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">MaxCircuit</span><span class="Other">;</span>
<span class="Identifier">maxCircuitPerPeer</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">MaxCircuitPerPeer</span><span class="Other">;</span>
<span class="Identifier">msgSize</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">RelayMsgSize</span><span class="Other">;</span> <span class="Identifier">circuitRelayV1</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">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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L321"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L321" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="setup,Relay,Switch" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#setup%2CRelay%2CSwitch"><span class="Identifier">setup</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">switch</span><span class="Other">:</span> <a href="../../../transports/transport.html#Switch"><span class="Identifier">Switch</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L314"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/relay.nim#L314" 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="start.e,Relay" class="tohide">
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
<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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
<dd>
&nbsp;&nbsp;<a
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L366"
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
&nbsp;&nbsp;<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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
</dd>
</div>
<div id="stop.e,Relay" class="tohide">
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
<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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
<dd>
&nbsp;&nbsp;<a
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
href="https://github.com/status-im/nim-libp2p/tree/message-id-mem/libp2p/protocols/connectivity/relay/relay.nim#L376"
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for message-id-mem
2024-03-19 14:53:07 +00:00
&nbsp;&nbsp;<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>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
</dd>
</div>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
update docs for message-id-mem
2024-05-01 11:15:22 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2024-05-01 11:15:12 UTC</small>
update docs for message-id-mem
2024-03-19 14:51:38 +00:00
</div>
</div>
</div>
</div>
</body>
</html>