vacp2p/nim-libp2p-experimental
1
0
Fork 0
mirror of https://github.com/vacp2p/nim-libp2p-experimental.git synced 2025-01-12 11:24:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
nim-libp2p-experimental/documentation/libp2p/protocols/relay.html
= aa59cbab91 update docs for documentation
2022-07-01 14:32:41 +00:00

725 lines
50 KiB
HTML
Raw Permalink Blame History

<?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/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/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="#AddConn"
title="AddConn = proc (conn: Connection): Future[void] {.gcsafe, raises: [Defect].}">AddConn</a></li>
<li><a class="reference" href="#Relay"
title="Relay = ref object of LPProtocol
switch*: Switch
peerId: PeerId
dialer: Dial
canHop: bool
streamCount: int
hopCount: CountTable[PeerId]
addConn: AddConn
maxCircuit*: int
maxCircuitPerPeer*: int
msgSize*: int">Relay</a></li>
<li><a class="reference" href="#RelayError"
title="RelayError = object of LPError">RelayError</a></li>
<li><a class="reference" href="#RelayMessage"
title="RelayMessage = object
msgType*: Option[RelayType]
srcPeer*: Option[RelayPeer]
dstPeer*: Option[RelayPeer]
status*: Option[RelayStatus]">RelayMessage</a></li>
<li><a class="reference" href="#RelayPeer"
title="RelayPeer = object
peerId*: PeerId
addrs*: seq[MultiAddress]">RelayPeer</a></li>
<li><a class="reference" href="#RelayStatus"
title="RelayStatus = enum
Success = 100, HopSrcAddrTooLong = 220, HopDstAddrTooLong = 221,
HopSrcMultiaddrInvalid = 250, HopDstMultiaddrInvalid = 251,
HopNoConnToDst = 260, HopCantDialDst = 261, HopCantOpenDstStream = 262,
HopCantSpeakRelay = 270, HopCantRelayToSelf = 280, StopSrcAddrTooLong = 320,
StopDstAddrTooLong = 321, StopSrcMultiaddrInvalid = 350,
StopDstMultiaddrInvalid = 351, StopRelayRefused = 390, MalformedMessage = 400">RelayStatus</a></li>
<li><a class="reference" href="#RelayTransport"
title="RelayTransport = ref object of Transport
relay*: Relay
queue: AsyncQueue[Connection]
relayRunning: bool">RelayTransport</a></li>
<li><a class="reference" href="#RelayType"
title="RelayType = enum
Hop = 1, Stop = 2, Status = 3, CanHop = 4">RelayType</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="#MaxCircuit"
title="MaxCircuit = 1024">MaxCircuit</a></li>
<li><a class="reference" href="#MaxCircuitPerPeer"
title="MaxCircuitPerPeer = 64">MaxCircuitPerPeer</a></li>
<li><a class="reference" href="#MsgSize"
title="MsgSize = 4096">MsgSize</a></li>
<li><a class="reference" href="#RelayCodec"
title="RelayCodec = &quot;/libp2p/circuit/relay/0.1.0&quot;">RelayCodec</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">decodeMsg
<li><a class="reference" href="#decodeMsg%2Cseq%5Bbyte%5D"
title="decodeMsg(buf: seq[byte]): Option[RelayMessage]">decodeMsg(buf: seq[byte]): Option[RelayMessage]</a></li>
</ul>
<ul class="simple nested-toc-section">dial
<li><a class="reference" href="#dial%2CRelayTransport%2CMultiAddress"
title="dial(self: RelayTransport; ma: MultiAddress): Future[Connection]">dial(self: RelayTransport; ma: MultiAddress): Future[Connection]</a></li>
</ul>
<ul class="simple nested-toc-section">encodeMsg
<li><a class="reference" href="#encodeMsg%2CRelayMessage"
title="encodeMsg(msg: RelayMessage): ProtoBuffer">encodeMsg(msg: RelayMessage): ProtoBuffer</a></li>
</ul>
<ul class="simple nested-toc-section">new
<li><a class="reference" href="#new%2Ctypedesc%5BRelay%5D%2CSwitch%2Cbool"
title="new(T: typedesc[Relay]; switch: Switch; canHop: bool): T:type">new(T: typedesc[Relay]; switch: Switch; canHop: bool): T:type</a></li>
<li><a class="reference" href="#new%2Ctypedesc%5BRelayTransport%5D%2CRelay%2CUpgrade"
title="new(T: typedesc[RelayTransport]; relay: Relay; upgrader: Upgrade): T:type">new(T: typedesc[RelayTransport]; relay: Relay; upgrader: Upgrade): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">sendStatus
<li><a class="reference" href="#sendStatus%2CConnection%2CRelayStatus"
title="sendStatus(conn: Connection; code: RelayStatus): Future[void]">sendStatus(conn: Connection; code: RelayStatus): Future[void]</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">accept
<li><a class="reference" href="#accept.e%2CRelayTransport"
title="accept(self: RelayTransport): Future[Connection]">accept(self: RelayTransport): Future[Connection]</a></li>
</ul>
<ul class="simple nested-toc-section">dial
<li><a class="reference" href="#dial.e%2CRelayTransport%2Cstring%2CMultiAddress"
title="dial(self: RelayTransport; hostname: string; address: MultiAddress): Future[
Connection]">dial(self: RelayTransport; hostname: string; address: MultiAddress): Future[
Connection]</a></li>
</ul>
<ul class="simple nested-toc-section">handles
<li><a class="reference" href="#handles.e%2CRelayTransport%2CMultiAddress"
title="handles(self: RelayTransport; ma: MultiAddress): bool">handles(self: RelayTransport; ma: MultiAddress): bool</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init.e%2CRelay"
title="init(r: Relay)">init(r: Relay)</a></li>
</ul>
<ul class="simple nested-toc-section">start
<li><a class="reference" href="#start.e%2CRelayTransport%2Cseq%5BMultiAddress%5D"
title="start(self: RelayTransport; ma: seq[MultiAddress]): Future[void]">start(self: RelayTransport; ma: seq[MultiAddress]): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">stop
<li><a class="reference" href="#stop.e%2CRelayTransport"
title="stop(self: RelayTransport): Future[void]">stop(self: RelayTransport): Future[void]</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/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/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="../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="../stream/connection.html">../stream/connection</a>, <a class="reference external" href="protocol.html">protocol</a>, <a class="reference external" href="../transports/transport.html">../transports/transport</a>, <a class="reference external" href="../utility.html">../utility</a>, <a class="reference external" href="../errors.html">../errors</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="AddConn" class="tohide">
<dt><pre><a href="relay.html#AddConn"><span class="Identifier">AddConn</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L64"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<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">peerId</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
<span class="Identifier">dialer</span><span class="Other">:</span> <a href="../dial.html#Dial"><span class="Identifier">Dial</span></a>
<span class="Identifier">canHop</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">hopCount</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">addConn</span><span class="Other">:</span> <a href="relay.html#AddConn"><span class="Identifier">AddConn</span></a>
<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>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L72"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayError" class="tohide">
<dt><pre><a href="relay.html#RelayError"><span class="Identifier">RelayError</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/documentation/libp2p/protocols/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/relay.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayMessage" class="tohide">
<dt><pre><a href="relay.html#RelayMessage"><span class="Identifier">RelayMessage</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">msgType</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="relay.html#RelayType"><span class="Identifier">RelayType</span></a><span class="Other">]</span>
<span class="Identifier">srcPeer</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="relay.html#RelayPeer"><span class="Identifier">RelayPeer</span></a><span class="Other">]</span>
<span class="Identifier">dstPeer</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="relay.html#RelayPeer"><span class="Identifier">RelayPeer</span></a><span class="Other">]</span>
<span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="relay.html#RelayStatus"><span class="Identifier">RelayStatus</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L66"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayPeer" class="tohide">
<dt><pre><a href="relay.html#RelayPeer"><span class="Identifier">RelayPeer</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">peerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
<span class="Identifier">addrs</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L60"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayStatus" class="tohide">
<dt><pre><a href="relay.html#RelayStatus"><span class="Identifier">RelayStatus</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Success</span> <span class="Other">=</span> <span class="DecNumber">100</span><span class="Other">,</span> <span class="Identifier">HopSrcAddrTooLong</span> <span class="Other">=</span> <span class="DecNumber">220</span><span class="Other">,</span> <span class="Identifier">HopDstAddrTooLong</span> <span class="Other">=</span> <span class="DecNumber">221</span><span class="Other">,</span>
<span class="Identifier">HopSrcMultiaddrInvalid</span> <span class="Other">=</span> <span class="DecNumber">250</span><span class="Other">,</span> <span class="Identifier">HopDstMultiaddrInvalid</span> <span class="Other">=</span> <span class="DecNumber">251</span><span class="Other">,</span>
<span class="Identifier">HopNoConnToDst</span> <span class="Other">=</span> <span class="DecNumber">260</span><span class="Other">,</span> <span class="Identifier">HopCantDialDst</span> <span class="Other">=</span> <span class="DecNumber">261</span><span class="Other">,</span> <span class="Identifier">HopCantOpenDstStream</span> <span class="Other">=</span> <span class="DecNumber">262</span><span class="Other">,</span>
<span class="Identifier">HopCantSpeakRelay</span> <span class="Other">=</span> <span class="DecNumber">270</span><span class="Other">,</span> <span class="Identifier">HopCantRelayToSelf</span> <span class="Other">=</span> <span class="DecNumber">280</span><span class="Other">,</span> <span class="Identifier">StopSrcAddrTooLong</span> <span class="Other">=</span> <span class="DecNumber">320</span><span class="Other">,</span>
<span class="Identifier">StopDstAddrTooLong</span> <span class="Other">=</span> <span class="DecNumber">321</span><span class="Other">,</span> <span class="Identifier">StopSrcMultiaddrInvalid</span> <span class="Other">=</span> <span class="DecNumber">350</span><span class="Other">,</span>
<span class="Identifier">StopDstMultiaddrInvalid</span> <span class="Other">=</span> <span class="DecNumber">351</span><span class="Other">,</span> <span class="Identifier">StopRelayRefused</span> <span class="Other">=</span> <span class="DecNumber">390</span><span class="Other">,</span> <span class="Identifier">MalformedMessage</span> <span class="Other">=</span> <span class="DecNumber">400</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/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/relay.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayTransport" class="tohide">
<dt><pre><a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../upgrademngrs/upgrade.html#Transport"><span class="Identifier">Transport</span></a>
<span class="Identifier">relay</span><span class="Operator">*</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</span></a>
<span class="Identifier">queue</span><span class="Other">:</span> <span class="Identifier">AsyncQueue</span><span class="Other">[</span><a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span>
<span class="Identifier">relayRunning</span><span class="Other">:</span> <span class="Identifier">bool</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L429"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L429" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayType" class="tohide">
<dt><pre><a href="relay.html#RelayType"><span class="Identifier">RelayType</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Hop</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span> <span class="Identifier">Stop</span> <span class="Other">=</span> <span class="DecNumber">2</span><span class="Other">,</span> <span class="Identifier">Status</span> <span class="Other">=</span> <span class="DecNumber">3</span><span class="Other">,</span> <span class="Identifier">CanHop</span> <span class="Other">=</span> <span class="DecNumber">4</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L35"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L35" 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="MaxCircuit" class="tohide">
<dt><pre><a href="relay.html#MaxCircuit"><span class="Identifier">MaxCircuit</span></a> <span class="Other">=</span> <span class="DecNumber">1024</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L28"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L28" 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">64</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L29"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MsgSize" class="tohide">
<dt><pre><a href="relay.html#MsgSize"><span class="Identifier">MsgSize</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/documentation/libp2p/protocols/relay.nim#L27"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayCodec" class="tohide">
<dt><pre><a href="relay.html#RelayCodec"><span class="Identifier">RelayCodec</span></a> <span class="Other">=</span> <span class="StringLit">&quot;/libp2p/circuit/relay/0.1.0&quot;</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L26"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L26" 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="decodeMsg,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decodeMsg%2Cseq%5Bbyte%5D"><span class="Identifier">decodeMsg</span></a><span class="Other">(</span><span class="Identifier">buf</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">Option</span><span class="Other">[</span><a href="relay.html#RelayMessage"><span class="Identifier">RelayMessage</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="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L110"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L110" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="dial,RelayTransport,MultiAddress" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#dial%2CRelayTransport%2CMultiAddress"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
</span><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L455"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L455" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encodeMsg,RelayMessage" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encodeMsg%2CRelayMessage"><span class="Identifier">encodeMsg</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="relay.html#RelayMessage"><span class="Identifier">RelayMessage</span></a><span class="Other">)</span><span class="Other">:</span> <a href="../protobuf/minprotobuf.html#ProtoBuffer"><span class="Identifier">ProtoBuffer</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="Identifier">Defect</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/documentation/libp2p/protocols/relay.nim#L86"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L86" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="new,typedesc[Relay],Switch,bool" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BRelay%5D%2CSwitch%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">switch</span><span class="Other">:</span> <a href="../transports/transport.html#Switch"><span class="Identifier">Switch</span></a><span class="Other">;</span> <span class="Identifier">canHop</span><span class="Other">:</span> <span class="Identifier">bool</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="Identifier">Defect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L336"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L336" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="new,typedesc[RelayTransport],Relay,Upgrade" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BRelayTransport%5D%2CRelay%2CUpgrade"><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#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">relay</span><span class="Other">:</span> <a href="relay.html#Relay"><span class="Identifier">Relay</span></a><span class="Other">;</span> <span class="Identifier">upgrader</span><span class="Other">:</span> <a href="../peerstore.html#Upgrade"><span class="Identifier">Upgrade</span></a><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="Identifier">Defect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/documentation/libp2p/protocols/relay.nim#L485"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L485" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="sendStatus,Connection,RelayStatus" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#sendStatus%2CConnection%2CRelayStatus"><span class="Identifier">sendStatus</span></a><span class="Other">(</span><span class="Identifier">conn</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">code</span><span class="Other">:</span> <a href="relay.html#RelayStatus"><span class="Identifier">RelayStatus</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
</span><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L146"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L146" 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="accept.e,RelayTransport" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#accept.e%2CRelayTransport"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
</span><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L452"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L452" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="dial.e,RelayTransport,string,MultiAddress" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#dial.e%2CRelayTransport%2Cstring%2CMultiAddress"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">hostname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
<a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L474"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L474" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handles.e,RelayTransport,MultiAddress" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#handles.e%2CRelayTransport%2CMultiAddress"><span class="Identifier">handles</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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="Identifier">Defect</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/documentation/libp2p/protocols/relay.nim#L477"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L477" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init.e,Relay" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CRelay"><span class="Identifier">init</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</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/documentation/libp2p/protocols/relay.nim#L341"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L341" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="start.e,RelayTransport,seq[MultiAddress]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CRelayTransport%2Cseq%5BMultiAddress%5D"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">;</span> <span class="Identifier">ma</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L434"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L434" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="stop.e,RelayTransport" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CRelayTransport"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="relay.html#RelayTransport"><span class="Identifier">RelayTransport</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</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/documentation/libp2p/protocols/relay.nim#L445"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/relay.nim#L445" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2022-07-01 14:32:37 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink