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/unstable/libp2p/protocols/connectivity/relay/messages.html

733 lines
50 KiB
HTML
Raw Normal View History

update docs for unstable
2023-11-16 14:59:42 +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/messages</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/messages</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="#HopMessage"
title="HopMessage = object
msgType*: HopMessageType
peer*: Opt[Peer]
reservation*: Opt[Reservation]
limit*: Limit
status*: Opt[StatusV2]">HopMessage</a></li>
<li><a class="reference" href="#HopMessageType"
title="HopMessageType {.pure.} = enum
Reserve = 0, Connect = 1, Status = 2">HopMessageType</a></li>
<li><a class="reference" href="#Limit"
title="Limit = object
duration*: uint32
data*: uint64">Limit</a></li>
<li><a class="reference" href="#Peer"
title="Peer = object
peerId*: PeerId
addrs*: seq[MultiAddress]">Peer</a></li>
<li><a class="reference" href="#RelayMessage"
title="RelayMessage = object
msgType*: Opt[RelayType]
srcPeer*: Opt[RelayPeer]
dstPeer*: Opt[RelayPeer]
status*: Opt[StatusV1]">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="#RelayType"
title="RelayType {.pure.} = enum
Hop = 1, Stop = 2, Status = 3, CanHop = 4">RelayType</a></li>
<li><a class="reference" href="#Reservation"
title="Reservation = object
expire*: uint64
addrs*: seq[MultiAddress]
svoucher*: Opt[seq[byte]]">Reservation</a></li>
<li><a class="reference" href="#SignedVoucher"
title="SignedVoucher = SignedPayload[Voucher]">SignedVoucher</a></li>
<li><a class="reference" href="#StatusV1"
title="StatusV1 {.pure.} = 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">StatusV1</a></li>
<li><a class="reference" href="#StatusV2"
title="StatusV2 = enum
Ok = 100, ReservationRefused = 200, ResourceLimitExceeded = 201,
PermissionDenied = 202, ConnectionFailed = 203, NoReservation = 204,
MalformedMessage = 400, UnexpectedMessage = 401">StatusV2</a></li>
<li><a class="reference" href="#StopMessage"
title="StopMessage = object
msgType*: StopMessageType
peer*: Opt[Peer]
limit*: Limit
status*: Opt[StatusV2]">StopMessage</a></li>
<li><a class="reference" href="#StopMessageType"
title="StopMessageType {.pure.} = enum
Connect = 0, Status = 1">StopMessageType</a></li>
<li><a class="reference" href="#Voucher"
title="Voucher = object
relayPeerId*: PeerId
reservingPeerId*: PeerId
expiration*: uint64">Voucher</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">checkValid
<li><a class="reference" href="#checkValid%2CSignedVoucher"
title="checkValid(spr: SignedVoucher): Result[void, EnvelopeError]">checkValid(spr: SignedVoucher): Result[void, EnvelopeError]</a></li>
</ul>
<ul class="simple nested-toc-section">decode
<li><a class="reference" href="#decode%2Ctypedesc%5BHopMessage%5D%2Cseq%5Bbyte%5D"
title="decode(_: typedesc[HopMessage]; buf: seq[byte]): Opt[HopMessage]">decode(_: typedesc[HopMessage]; buf: seq[byte]): Opt[HopMessage]</a></li>
<li><a class="reference" href="#decode%2Ctypedesc%5BRelayMessage%5D%2Cseq%5Bbyte%5D"
title="decode(_: typedesc[RelayMessage]; buf: seq[byte]): Opt[RelayMessage]">decode(_: typedesc[RelayMessage]; buf: seq[byte]): Opt[RelayMessage]</a></li>
<li><a class="reference" href="#decode%2Ctypedesc%5BStopMessage%5D%2Cseq%5Bbyte%5D"
title="decode(_: typedesc[StopMessage]; buf: seq[byte]): Opt[StopMessage]">decode(_: typedesc[StopMessage]; buf: seq[byte]): Opt[StopMessage]</a></li>
<li><a class="reference" href="#decode%2Ctypedesc%5BVoucher%5D%2Cseq%5Bbyte%5D"
title="decode(_: typedesc[Voucher]; buf: seq[byte]): Result[Voucher, ProtoError]">decode(_: typedesc[Voucher]; buf: seq[byte]): Result[Voucher, ProtoError]</a></li>
</ul>
<ul class="simple nested-toc-section">encode
<li><a class="reference" href="#encode%2CHopMessage"
title="encode(msg: HopMessage): ProtoBuffer">encode(msg: HopMessage): ProtoBuffer</a></li>
<li><a class="reference" href="#encode%2CRelayMessage"
title="encode(msg: RelayMessage): ProtoBuffer">encode(msg: RelayMessage): ProtoBuffer</a></li>
<li><a class="reference" href="#encode%2CStopMessage"
title="encode(msg: StopMessage): ProtoBuffer">encode(msg: StopMessage): ProtoBuffer</a></li>
<li><a class="reference" href="#encode%2CVoucher"
title="encode(v: Voucher): seq[byte]">encode(v: Voucher): seq[byte]</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2Ctypedesc%5BVoucher%5D%2CPeerId%2CPeerId%2Cuint64"
title="init(T: typedesc[Voucher]; relayPeerId: PeerId; reservingPeerId: PeerId;
expiration: uint64): T:type">init(T: typedesc[Voucher]; relayPeerId: PeerId; reservingPeerId: PeerId;
expiration: uint64): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">payloadDomain
<li><a class="reference" href="#payloadDomain%2Ctypedesc%5BVoucher%5D"
title="payloadDomain(_: typedesc[Voucher]): string">payloadDomain(_: typedesc[Voucher]): string</a></li>
</ul>
<ul class="simple nested-toc-section">payloadType
<li><a class="reference" href="#payloadType%2Ctypedesc%5BVoucher%5D"
title="payloadType(_: typedesc[Voucher]): seq[byte]">payloadType(_: typedesc[Voucher]): seq[byte]</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.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/messages.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="../../../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="HopMessage" class="tohide">
<dt><pre><a href="messages.html#HopMessage"><span class="Identifier">HopMessage</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">msgType</span><span class="Operator">*</span><span class="Other">:</span> <a href="messages.html#HopMessageType"><span class="Identifier">HopMessageType</span></a>
<span class="Identifier">peer</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="messages.html#Peer"><span class="Identifier">Peer</span></a><span class="Other">]</span>
<span class="Identifier">reservation</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="messages.html#Reservation"><span class="Identifier">Reservation</span></a><span class="Other">]</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>
<span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="messages.html#StatusV2"><span class="Identifier">StatusV2</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L188"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L188" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="HopMessageType" class="tohide">
<dt><pre><a href="messages.html#HopMessageType"><span class="Identifier">HopMessageType</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Reserve</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">Connect</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span> <span class="Identifier">Status</span> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L184"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L184" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="Limit" class="tohide">
<dt><pre><a href="messages.html#Limit"><span class="Identifier">Limit</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">duration</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint32</span>
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L171"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L171" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="Peer" class="tohide">
<dt><pre><a href="messages.html#Peer"><span class="Identifier">Peer</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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L164"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L164" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayMessage" class="tohide">
<dt><pre><a href="messages.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">Opt</span><span class="Other">[</span><a href="messages.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">Opt</span><span class="Other">[</span><a href="messages.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">Opt</span><span class="Other">[</span><a href="messages.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">Opt</span><span class="Other">[</span><a href="messages.html#StatusV1"><span class="Identifier">StatusV1</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L48"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayPeer" class="tohide">
<dt><pre><a href="messages.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/unstable/libp2p/protocols/connectivity/relay/messages.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/messages.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="RelayType" class="tohide">
<dt><pre><a href="messages.html#RelayType"><span class="Identifier">RelayType</span></a> {.<span class="Identifier">pure</span>.} <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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L20"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L20" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="Reservation" class="tohide">
<dt><pre><a href="messages.html#Reservation"><span class="Identifier">Reservation</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">expire</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
<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>
<span class="Identifier">svoucher</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</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>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L167"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L167" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="SignedVoucher" class="tohide">
<dt><pre><a href="messages.html#SignedVoucher"><span class="Identifier">SignedVoucher</span></a> <span class="Other">=</span> <a href="../../../signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">]</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L150"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L150" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="StatusV1" class="tohide">
<dt><pre><a href="messages.html#StatusV1"><span class="Identifier">StatusV1</span></a> {.<span class="Identifier">pure</span>.} <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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L26"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L26" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="StatusV2" class="tohide">
<dt><pre><a href="messages.html#StatusV2"><span class="Identifier">StatusV2</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Ok</span> <span class="Other">=</span> <span class="DecNumber">100</span><span class="Other">,</span> <span class="Identifier">ReservationRefused</span> <span class="Other">=</span> <span class="DecNumber">200</span><span class="Other">,</span> <span class="Identifier">ResourceLimitExceeded</span> <span class="Other">=</span> <span class="DecNumber">201</span><span class="Other">,</span>
<span class="Identifier">PermissionDenied</span> <span class="Other">=</span> <span class="DecNumber">202</span><span class="Other">,</span> <span class="Identifier">ConnectionFailed</span> <span class="Other">=</span> <span class="DecNumber">203</span><span class="Other">,</span> <span class="Identifier">NoReservation</span> <span class="Other">=</span> <span class="DecNumber">204</span><span class="Other">,</span>
<span class="Identifier">MalformedMessage</span> <span class="Other">=</span> <span class="DecNumber">400</span><span class="Other">,</span> <span class="Identifier">UnexpectedMessage</span> <span class="Other">=</span> <span class="DecNumber">401</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L175"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L175" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="StopMessage" class="tohide">
<dt><pre><a href="messages.html#StopMessage"><span class="Identifier">StopMessage</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">msgType</span><span class="Operator">*</span><span class="Other">:</span> <a href="messages.html#StopMessageType"><span class="Identifier">StopMessageType</span></a>
<span class="Identifier">peer</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="messages.html#Peer"><span class="Identifier">Peer</span></a><span class="Other">]</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>
<span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="messages.html#StatusV2"><span class="Identifier">StatusV2</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L273"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L273" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="StopMessageType" class="tohide">
<dt><pre><a href="messages.html#StopMessageType"><span class="Identifier">StopMessageType</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Connect</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">Status</span> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L270"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L270" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="Voucher" class="tohide">
<dt><pre><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">relayPeerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
<span class="Identifier">reservingPeerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
<span class="Identifier">expiration</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L115"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L115" 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="checkValid,SignedVoucher" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#checkValid%2CSignedVoucher"><span class="Identifier">checkValid</span></a><span class="Other">(</span><span class="Identifier">spr</span><span class="Other">:</span> <a href="messages.html#SignedVoucher"><span class="Identifier">SignedVoucher</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <a href="../../../signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L155"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[HopMessage],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BHopMessage%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="messages.html#HopMessage"><span class="Identifier">HopMessage</span></a><span class="Other">]</span><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">Opt</span><span class="Other">[</span><a href="messages.html#HopMessage"><span class="Identifier">HopMessage</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L227"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L227" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[RelayMessage],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BRelayMessage%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</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">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">Opt</span><span class="Other">[</span><a href="messages.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="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L78"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[StopMessage],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BStopMessage%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="messages.html#StopMessage"><span class="Identifier">StopMessage</span></a><span class="Other">]</span><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">Opt</span><span class="Other">[</span><a href="messages.html#StopMessage"><span class="Identifier">StopMessage</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L303"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L303" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[Voucher],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BVoucher%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">]</span><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">Result</span><span class="Other">[</span><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">,</span> <a href="../../../protobuf/minprotobuf.html#ProtoError"><span class="Identifier">ProtoError</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L120"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,HopMessage" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CHopMessage"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="messages.html#HopMessage"><span class="Identifier">HopMessage</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="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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L195"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L195" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,RelayMessage" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CRelayMessage"><span class="Identifier">encode</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> <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="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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L54"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,StopMessage" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CStopMessage"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="messages.html#StopMessage"><span class="Identifier">StopMessage</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="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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L280"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L280" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,Voucher" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CVoucher"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">v</span><span class="Other">:</span> <a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L130"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L130" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[Voucher],PeerId,PeerId,uint64" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BVoucher%5D%2CPeerId%2CPeerId%2Cuint64"><span class="Identifier">init</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="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">relayPeerId</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">reservingPeerId</span><span class="Other">:</span> <a href="../../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span>
<span class="Identifier">expiration</span><span class="Other">:</span> <span class="Identifier">uint64</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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L140"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L140" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="payloadDomain,typedesc[Voucher]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#payloadDomain%2Ctypedesc%5BVoucher%5D"><span class="Identifier">payloadDomain</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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/unstable/libp2p/protocols/connectivity/relay/messages.nim#L152"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L152" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="payloadType,typedesc[Voucher]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#payloadType%2Ctypedesc%5BVoucher%5D"><span class="Identifier">payloadType</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="messages.html#Voucher"><span class="Identifier">Voucher</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/protocols/connectivity/relay/messages.nim#L153"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/relay/messages.nim#L153" 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/>
update docs for unstable
2024-03-25 11:08:22 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-25 11:08:13 UTC</small>
update docs for unstable
2023-11-16 14:59:42 +00:00
</div>
</div>
</div>
</div>
</body>
</html>