vacp2p/nim-libp2p-experimental
1
0
Fork 0
mirror of https://github.com/vacp2p/nim-libp2p-experimental.git synced 2025-01-13 03:44:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
nim-libp2p-experimental/autonat-service/libp2p/protocols/connectivity/autonat.html

560 lines
32 KiB
HTML
Raw Normal View History

update docs for autonat-service
2022-12-05 11:33:13 +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/autonat</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/autonat</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="#Autonat"
title="Autonat = ref object of LPProtocol
sem: AsyncSemaphore
switch*: Switch">Autonat</a></li>
<li><a class="reference" href="#AutonatDial"
title="AutonatDial = object
peerInfo: Option[AutonatPeerInfo]">AutonatDial</a></li>
<li><a class="reference" href="#AutonatDialResponse"
title="AutonatDialResponse = object
status*: ResponseStatus
text*: Option[string]
ma*: Option[MultiAddress]">AutonatDialResponse</a></li>
<li><a class="reference" href="#AutonatError"
title="AutonatError = object of LPError">AutonatError</a></li>
<li><a class="reference" href="#AutonatPeerInfo"
title="AutonatPeerInfo = object
id: Option[PeerId]
addrs: seq[MultiAddress]">AutonatPeerInfo</a></li>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
<li><a class="reference" href="#DialMeResponse"
title="DialMeResponse = object
successfulAddress*: Option[MultiAddress]
text*: Option[string]
networkReachability*: NetworkReachability">DialMeResponse</a></li>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
<li><a class="reference" href="#MsgType"
title="MsgType = enum
Dial = 0, DialResponse = 1">MsgType</a></li>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
<li><a class="reference" href="#NetworkReachability"
title="NetworkReachability {.pure.} = enum
NotReachable, Reachable, Unknown">NetworkReachability</a></li>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
<li><a class="reference" href="#ResponseStatus"
title="ResponseStatus = enum
Ok = 0, DialError = 100, DialRefused = 101, BadRequest = 200,
InternalError = 300">ResponseStatus</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="#AutonatCodec"
title="AutonatCodec = &quot;/libp2p/autonat/1.0.0&quot;">AutonatCodec</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">encode
<li><a class="reference" href="#encode%2CAutonatDial"
title="encode(d: AutonatDial): ProtoBuffer">encode(d: AutonatDial): ProtoBuffer</a></li>
<li><a class="reference" href="#encode%2CAutonatMsg"
title="encode(msg: AutonatMsg): ProtoBuffer">encode(msg: AutonatMsg): ProtoBuffer</a></li>
<li><a class="reference" href="#encode%2CAutonatDialResponse"
title="encode(r: AutonatDialResponse): ProtoBuffer">encode(r: AutonatDialResponse): ProtoBuffer</a></li>
</ul>
<ul class="simple nested-toc-section">new
<li><a class="reference" href="#new%2Ctypedesc%5BAutonat%5D%2CSwitch%2Cint"
title="new(T: typedesc[Autonat]; switch: Switch; semSize: int = 1): T:type">new(T: typedesc[Autonat]; switch: Switch; semSize: int = 1): T:type</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">dialMe
<li><a class="reference" href="#dialMe.e%2CAutonat%2CPeerId%2Cseq%5BMultiAddress%5D"
title="dialMe(a: Autonat; pid: PeerId;
update docs for autonat-service
2022-12-06 11:29:11 +00:00
addrs: seq[MultiAddress] = newSeq[MultiAddress]()): Future[DialMeResponse]">dialMe(a: Autonat; pid: PeerId;
addrs: seq[MultiAddress] = newSeq[MultiAddress]()): Future[DialMeResponse]</a></li>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init.e%2CAutonat"
title="init(a: Autonat)">init(a: Autonat)</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.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/autonat.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="../protocol.html">../protocol</a>, <a class="reference external" href="../../switch.html">../../switch</a>, <a class="reference external" href="../../multiaddress.html">../../multiaddress</a>, <a class="reference external" href="../../multicodec.html">../../multicodec</a>, <a class="reference external" href="../../peerid.html">../../peerid</a>, <a class="reference external" href="../../utils/semaphore.html">../../utils/semaphore</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="Autonat" class="tohide">
<dt><pre><a href="autonat.html#Autonat"><span class="Identifier">Autonat</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">sem</span><span class="Other">:</span> <a href="../../utils/semaphore.html#AsyncSemaphore"><span class="Identifier">AsyncSemaphore</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>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L210"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L210" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="AutonatDial" class="tohide">
<dt><pre><a href="autonat.html#AutonatDial"><span class="Identifier">AutonatDial</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">peerInfo</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="autonat.html#AutonatPeerInfo"><span class="Identifier">AutonatPeerInfo</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L51"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="AutonatDialResponse" class="tohide">
<dt><pre><a href="autonat.html#AutonatDialResponse"><span class="Identifier">AutonatDialResponse</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="autonat.html#ResponseStatus"><span class="Identifier">ResponseStatus</span></a>
<span class="Identifier">text</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span>
<span class="Identifier">ma</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</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/autonat-service/libp2p/protocols/connectivity/autonat.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/autonat.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="AutonatError" class="tohide">
<dt><pre><a href="autonat.html#AutonatError"><span class="Identifier">AutonatError</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/autonat-service/libp2p/protocols/connectivity/autonat.nim#L34"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="AutonatPeerInfo" class="tohide">
<dt><pre><a href="autonat.html#AutonatPeerInfo"><span class="Identifier">AutonatPeerInfo</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">id</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">]</span>
<span class="Identifier">addrs</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/autonat-service/libp2p/protocols/connectivity/autonat.nim#L47"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
</dd>
</div>
<div id="DialMeResponse" class="tohide">
<dt><pre><a href="autonat.html#DialMeResponse"><span class="Identifier">DialMeResponse</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">successfulAddress</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span>
<span class="Identifier">text</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span>
<span class="Identifier">networkReachability</span><span class="Operator">*</span><span class="Other">:</span> <a href="autonat.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L67"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="MsgType" class="tohide">
<dt><pre><a href="autonat.html#MsgType"><span class="Identifier">MsgType</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Dial</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">DialResponse</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/autonat-service/libp2p/protocols/connectivity/autonat.nim#L36"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
</dd>
</div>
<div id="NetworkReachability" class="tohide">
<dt><pre><a href="autonat.html#NetworkReachability"><span class="Identifier">NetworkReachability</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">NotReachable</span><span class="Other">,</span> <span class="Identifier">Reachable</span><span class="Other">,</span> <span class="Identifier">Unknown</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L64"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="ResponseStatus" class="tohide">
<dt><pre><a href="autonat.html#ResponseStatus"><span class="Identifier">ResponseStatus</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Ok</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">DialError</span> <span class="Other">=</span> <span class="DecNumber">100</span><span class="Other">,</span> <span class="Identifier">DialRefused</span> <span class="Other">=</span> <span class="DecNumber">101</span><span class="Other">,</span> <span class="Identifier">BadRequest</span> <span class="Other">=</span> <span class="DecNumber">200</span><span class="Other">,</span>
<span class="Identifier">InternalError</span> <span class="Other">=</span> <span class="DecNumber">300</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L40"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L40" 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="AutonatCodec" class="tohide">
<dt><pre><a href="autonat.html#AutonatCodec"><span class="Identifier">AutonatCodec</span></a> <span class="Other">=</span> <span class="StringLit">&quot;/libp2p/autonat/1.0.0&quot;</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L30"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L30" 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="encode,AutonatDial" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CAutonatDial"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <a href="autonat.html#AutonatDial"><span class="Identifier">AutonatDial</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
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L100"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="encode,AutonatMsg" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CAutonatMsg"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">AutonatMsg</span><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
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L72"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="encode,AutonatDialResponse" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CAutonatDialResponse"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="autonat.html#AutonatDialResponse"><span class="Identifier">AutonatDialResponse</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
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L117"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L117" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="new,typedesc[Autonat],Switch,int" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BAutonat%5D%2CSwitch%2Cint"><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="autonat.html#Autonat"><span class="Identifier">Autonat</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">semSize</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="DecNumber">1</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
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L334"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L334" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
</dl></div>
<div class="section" id="14">
<h1><a class="toc-backref" href="#14">Methods</a></h1>
<dl class="item">
<div id="dialMe.e,Autonat,PeerId,seq[MultiAddress]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#dialMe.e%2CAutonat%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">dialMe</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="autonat.html#Autonat"><span class="Identifier">Autonat</span></a><span class="Other">;</span> <span class="Identifier">pid</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span>
<span class="Identifier">addrs</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="Identifier">newSeq</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="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
<a href="autonat.html#DialMeResponse"><span class="Identifier">DialMeResponse</span></a><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
<dd>
&nbsp;&nbsp;<a
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L252"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L252" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
<div id="init.e,Autonat" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CAutonat"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="autonat.html#Autonat"><span class="Identifier">Autonat</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for autonat-service
2022-12-06 11:29:11 +00:00
href="https://github.com/status-im/nim-libp2p/tree/autonat-service/libp2p/protocols/connectivity/autonat.nim#L339"
update docs for autonat-service
2022-12-05 11:33:13 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/connectivity/autonat.nim#L339" class="link-seesrc" target="_blank" >Edit</a>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</dd>
</div>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
update docs for autonat-service
2022-12-06 11:29:11 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2022-12-06 11:29:01 UTC</small>
update docs for autonat-service
2022-12-05 11:33:13 +00:00
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink