831 lines
101 KiB
HTML
831 lines
101 KiB
HTML
<?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/pubsub/pubsubpeer</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/pubsub/pubsubpeer</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-switch-wrapper">
|
|
<label class="theme-switch" for="checkbox">
|
|
<input type="checkbox" id="checkbox" />
|
|
<div class="slider round"></div>
|
|
</label>
|
|
<em>Dark Mode</em>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple">
|
|
<li>
|
|
<a href="../../../theindex.html">Index</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="text" id="searchInput"
|
|
onkeyup="search()" />
|
|
</div>
|
|
<div>
|
|
Group by:
|
|
<select onchange="groupBy(this.value)">
|
|
<option value="section">Section</option>
|
|
<option value="type">Type</option>
|
|
</select>
|
|
</div>
|
|
<script type="text/javascript">
|
|
function main2() {
|
|
// Create the slider
|
|
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
|
|
var newSlider = document.createRange().createContextualFragment(`
|
|
<div class="theme-switch-wrapper">
|
|
<label class="theme-switch" for="internalcheckbox">
|
|
<input type="checkbox" id="internalcheckbox">
|
|
<div class="slider round"></div>
|
|
</label>
|
|
<em>Internal</em>
|
|
</div>
|
|
`);
|
|
|
|
var sliderInst = firstSlider.after(newSlider);
|
|
|
|
// Restore slider state from storage
|
|
var currentMode = localStorage.getItem('privateMode');
|
|
if (currentMode == "private") {
|
|
document.getElementById("internalcheckbox").checked = true;
|
|
} else {
|
|
hidePrivateProcs();
|
|
}
|
|
|
|
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
|
|
}
|
|
|
|
function hidePrivateProcs() {
|
|
var toHide = document.getElementsByClassName("tohide");
|
|
for (var i = 0; i < toHide.length; i++) {
|
|
var pragmas = toHide[i].querySelectorAll("span.Identifier");
|
|
var public = false;
|
|
for (var z = 0; z < pragmas.length; z++) {
|
|
if (pragmas[z].innerText == "public") {
|
|
public = true;
|
|
break;
|
|
}
|
|
}
|
|
if (public == false) {
|
|
toHide[i].style.display = "none";
|
|
toHide[i].classList.add("hidden");
|
|
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
|
|
for (var y = 0; y < links.length; y++) {
|
|
links[y].parentNode.style.display = "none";
|
|
links[y].parentNode.classList.add("hidden");
|
|
}
|
|
}
|
|
}
|
|
|
|
// TOC
|
|
var nestedSections = document.getElementsByClassName("nested-toc-section");
|
|
for (var i = 0; i < nestedSections.length; i++) {
|
|
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
|
|
nestedSections[i].style.display = "none";
|
|
nestedSections[i].classList.add("hidden");
|
|
}
|
|
}
|
|
|
|
var sections = document.getElementsByClassName("simple-toc-section");
|
|
for (var i = 0; i < sections.length; i++) {
|
|
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
|
|
sections[i].parentNode.style.display = "none";
|
|
sections[i].parentNode.classList.add("hidden");
|
|
}
|
|
|
|
}
|
|
|
|
// Sections
|
|
var sections = document.getElementsByClassName("section");
|
|
for (var i = 0; i < sections.length; i++) {
|
|
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
|
|
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
|
|
sections[i].style.display = "none";
|
|
sections[i].classList.add("hidden");
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
function showPrivateProcs() {
|
|
var toHide = Array.from(document.getElementsByClassName("hidden"));
|
|
for (var i = 0; i < toHide.length; i++) {
|
|
toHide[i].style.display = "";
|
|
toHide[i].classList.remove("hidden");
|
|
}
|
|
}
|
|
|
|
function togglePrivateProcs() {
|
|
if (document.getElementById("internalcheckbox").checked) {
|
|
localStorage.setItem('privateMode', 'private');
|
|
showPrivateProcs();
|
|
} else {
|
|
localStorage.setItem('privateMode', 'public');
|
|
hidePrivateProcs();
|
|
}
|
|
}
|
|
window.addEventListener("DOMContentLoaded", main2);
|
|
</script>
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
<ul class="simple simple-toc-section">
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#DropConn"
|
|
title="DropConn = proc (peer: PubSubPeer) {.gcsafe, raises: [].}">DropConn</a></li>
|
|
<li><a class="reference" href="#GetConn"
|
|
title="GetConn = proc (): Future[Connection] {.gcsafe, raises: [].}">GetConn</a></li>
|
|
<li><a class="reference" href="#OnEvent"
|
|
title="OnEvent = proc (peer: PubSubPeer; event: PubSubPeerEvent) {.gcsafe, raises: [].}">OnEvent</a></li>
|
|
<li><a class="reference" href="#PeerRateLimitError"
|
|
title="PeerRateLimitError = object of CatchableError">PeerRateLimitError</a></li>
|
|
<li><a class="reference" href="#PubSubObserver"
|
|
title="PubSubObserver = ref object
|
|
onRecv*: proc (peer: PubSubPeer; msgs: var RPCMsg) {.gcsafe, raises: [].}
|
|
onSend*: proc (peer: PubSubPeer; msgs: var RPCMsg) {.gcsafe, raises: [].}">PubSubObserver</a></li>
|
|
<li><a class="reference" href="#PubSubPeer"
|
|
title="PubSubPeer = ref object of RootObj
|
|
getConn*: GetConn
|
|
onEvent*: OnEvent
|
|
codec*: string
|
|
sendConn*: Connection
|
|
connectedFut: Future[void]
|
|
address*: Option[MultiAddress]
|
|
peerId*: PeerId
|
|
handler*: RPCHandler
|
|
observers*: ref seq[PubSubObserver]
|
|
score*: float64
|
|
sentIHaves*: Deque[HashSet[MessageId]]
|
|
heDontWants*: Deque[HashSet[SaltedId]] ## IDONTWANT contains unvalidated message id:s which may be long and/or
|
|
## expensive to look up, so we apply the same salting to them as during
|
|
## unvalidated message processing
|
|
iHaveBudget*: int
|
|
pingBudget*: int
|
|
maxMessageSize: int
|
|
appScore*: float64
|
|
behaviourPenalty*: float64
|
|
overheadRateLimitOpt*: Opt[TokenBucket]
|
|
rpcmessagequeue: RpcMessageQueue
|
|
maxNumElementsInNonPriorityQueue*: int
|
|
disconnected: bool">PubSubPeer</a></li>
|
|
<li><a class="reference" href="#PubSubPeerEvent"
|
|
title="PubSubPeerEvent = object
|
|
kind*: PubSubPeerEventKind">PubSubPeerEvent</a></li>
|
|
<li><a class="reference" href="#PubSubPeerEventKind"
|
|
title="PubSubPeerEventKind {.pure.} = enum
|
|
StreamOpened, StreamClosed, DisconnectionRequested">PubSubPeerEventKind</a></li>
|
|
<li><a class="reference" href="#RPCHandler"
|
|
title="RPCHandler = proc (peer: PubSubPeer; data: seq[byte]): Future[void] {.gcsafe,
|
|
raises: [].}">RPCHandler</a></li>
|
|
<li><a class="reference" href="#RpcMessageQueue"
|
|
title="RpcMessageQueue = ref object
|
|
sendPriorityQueue: Deque[Future[void]]
|
|
nonPriorityQueue: AsyncQueue[seq[byte]]
|
|
sendNonPriorityTask: Future[void]">RpcMessageQueue</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="#DefaultMaxNumElementsInNonPriorityQueue"
|
|
title="DefaultMaxNumElementsInNonPriorityQueue = 1024">DefaultMaxNumElementsInNonPriorityQueue</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">==
|
|
<li><a class="reference" href="#%3D%3D%2CPubSubPeer%2CPubSubPeer"
|
|
title="`==`(a, b: PubSubPeer): bool">`==`(a, b: PubSubPeer): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">canAskIWant
|
|
<li><a class="reference" href="#canAskIWant%2CPubSubPeer%2CMessageId"
|
|
title="canAskIWant(p: PubSubPeer; msgId: MessageId): bool">canAskIWant(p: PubSubPeer; msgId: MessageId): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">connect
|
|
<li><a class="reference" href="#connect%2CPubSubPeer"
|
|
title="connect(p: PubSubPeer)">connect(p: PubSubPeer)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">connected
|
|
<li><a class="reference" href="#connected%2CPubSubPeer"
|
|
title="connected(p: PubSubPeer): bool">connected(p: PubSubPeer): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getAgent
|
|
<li><a class="reference" href="#getAgent%2CPubSubPeer"
|
|
title="getAgent(peer: PubSubPeer): string">getAgent(peer: PubSubPeer): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">handle
|
|
<li><a class="reference" href="#handle%2CPubSubPeer%2CConnection"
|
|
title="handle(p: PubSubPeer; conn: Connection): Future[void]">handle(p: PubSubPeer; conn: Connection): Future[void]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hash
|
|
<li><a class="reference" href="#hash%2CPubSubPeer"
|
|
title="hash(p: PubSubPeer): Hash">hash(p: PubSubPeer): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hasObservers
|
|
<li><a class="reference" href="#hasObservers%2CPubSubPeer"
|
|
title="hasObservers(p: PubSubPeer): bool">hasObservers(p: PubSubPeer): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hasSendConn
|
|
<li><a class="reference" href="#hasSendConn%2CPubSubPeer"
|
|
title="hasSendConn(p: PubSubPeer): bool">hasSendConn(p: PubSubPeer): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">new
|
|
<li><a class="reference" href="#new%2Ctypedesc%5BPubSubPeer%5D%2CPeerId%2CGetConn%2COnEvent%2Cstring%2Cint%2Cint%2COpt%5BTokenBucket%5D"
|
|
title="new(T: typedesc[PubSubPeer]; peerId: PeerId; getConn: GetConn; onEvent: OnEvent;
|
|
codec: string; maxMessageSize: int; maxNumElementsInNonPriorityQueue: int = DefaultMaxNumElementsInNonPriorityQueue;
|
|
overheadRateLimitOpt: Opt[TokenBucket] = Opt.none(TokenBucket)): T:type">new(T: typedesc[PubSubPeer]; peerId: PeerId; getConn: GetConn; onEvent: OnEvent;
|
|
codec: string; maxMessageSize: int; maxNumElementsInNonPriorityQueue: int = DefaultMaxNumElementsInNonPriorityQueue;
|
|
overheadRateLimitOpt: Opt[TokenBucket] = Opt.none(TokenBucket)): T:type</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">outbound
|
|
<li><a class="reference" href="#outbound%2CPubSubPeer"
|
|
title="outbound(p: PubSubPeer): bool">outbound(p: PubSubPeer): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">recvObservers
|
|
<li><a class="reference" href="#recvObservers%2CPubSubPeer%2CRPCMsg"
|
|
title="recvObservers(p: PubSubPeer; msg: var RPCMsg)">recvObservers(p: PubSubPeer; msg: var RPCMsg)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">send
|
|
<li><a class="reference" href="#send%2CPubSubPeer%2CRPCMsg%2Cbool%2Cbool"
|
|
title="send(p: PubSubPeer; msg: RPCMsg; anonymize: bool; isHighPriority: bool)">send(p: PubSubPeer; msg: RPCMsg; anonymize: bool; isHighPriority: bool)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">sendEncoded
|
|
<li><a class="reference" href="#sendEncoded%2CPubSubPeer%2Cseq%5Bbyte%5D%2Cbool"
|
|
title="sendEncoded(p: PubSubPeer; msg: seq[byte]; isHighPriority: bool): Future[void]">sendEncoded(p: PubSubPeer; msg: seq[byte]; isHighPriority: bool): Future[void]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">shortLog
|
|
<li><a class="reference" href="#shortLog%2CPubSubPeer"
|
|
title="shortLog(p: PubSubPeer): string">shortLog(p: PubSubPeer): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">stopSendNonPriorityTask
|
|
<li><a class="reference" href="#stopSendNonPriorityTask%2CPubSubPeer"
|
|
title="stopSendNonPriorityTask(p: PubSubPeer)">stopSendNonPriorityTask(p: PubSubPeer)</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">formatItIMPL
|
|
<li><a class="reference" href="#formatItIMPL.t%2CPubSubPeer"
|
|
title="formatItIMPL(it: PubSubPeer): auto">formatItIMPL(it: PubSubPeer): auto</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
|
|
<ul class="simple simple-toc-section">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L1"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.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="rpc/messages.html">rpc/messages</a>, <a class="reference external" href="rpc/message.html">rpc/message</a>, <a class="reference external" href="rpc/protobuf.html">rpc/protobuf</a>, <a class="reference external" href="../../peerid.html">../../peerid</a>, <a class="reference external" href="../../peerinfo.html">../../peerinfo</a>, <a class="reference external" href="../../stream/connection.html">../../stream/connection</a>, <a class="reference external" href="../../crypto/crypto.html">../../crypto/crypto</a>, <a class="reference external" href="../../protobuf/minprotobuf.html">../../protobuf/minprotobuf</a>, <a class="reference external" href="../../utility.html">../../utility</a>
|
|
</dl></div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="DropConn" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#DropConn"><span class="Identifier">DropConn</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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 class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L59"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="GetConn" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#GetConn"><span class="Identifier">GetConn</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">]</span> {.<span><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>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L58"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="OnEvent" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#OnEvent"><span class="Identifier">OnEvent</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">event</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeerEvent"><span class="Identifier">PubSubPeerEvent</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 class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L60"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="PeerRateLimitError" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#PeerRateLimitError"><span class="Identifier">PeerRateLimitError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L44"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="PubSubObserver" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#PubSubObserver"><span class="Identifier">PubSubObserver</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">onRecv</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msgs</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</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 class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}
|
|
<span class="Identifier">onSend</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msgs</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</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 class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L46"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="PubSubPeer" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">RootObj</span>
|
|
<span class="Identifier">getConn</span><span class="Operator">*</span><span class="Other">:</span> <a href="pubsubpeer.html#GetConn"><span class="Identifier">GetConn</span></a>
|
|
<span class="Identifier">onEvent</span><span class="Operator">*</span><span class="Other">:</span> <a href="pubsubpeer.html#OnEvent"><span class="Identifier">OnEvent</span></a>
|
|
<span class="Identifier">codec</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
|
|
<span class="Identifier">sendConn</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>
|
|
<span class="Identifier">connectedFut</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">address</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">peerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
|
|
<span class="Identifier">handler</span><span class="Operator">*</span><span class="Other">:</span> <a href="pubsubpeer.html#RPCHandler"><span class="Identifier">RPCHandler</span></a>
|
|
<span class="Identifier">observers</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="pubsubpeer.html#PubSubObserver"><span class="Identifier">PubSubObserver</span></a><span class="Other">]</span>
|
|
<span class="Identifier">score</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float64</span>
|
|
<span class="Identifier">sentIHaves</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Deque</span><span class="Other">[</span><span class="Identifier">HashSet</span><span class="Other">[</span><a href="rpc/messages.html#MessageId"><span class="Identifier">MessageId</span></a><span class="Other">]</span><span class="Other">]</span>
|
|
<span class="Identifier">heDontWants</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Deque</span><span class="Other">[</span><span class="Identifier">HashSet</span><span class="Other">[</span><a href="rpc/messages.html#SaltedId"><span class="Identifier">SaltedId</span></a><span class="Other">]</span><span class="Other">]</span> <span class="Comment">## IDONTWANT contains unvalidated message id:s which may be long and/or</span>
|
|
<span class="Comment">## expensive to look up, so we apply the same salting to them as during</span>
|
|
<span class="Comment">## unvalidated message processing</span>
|
|
<span class="Identifier">iHaveBudget</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">pingBudget</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">maxMessageSize</span><span class="Other">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">appScore</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float64</span>
|
|
<span class="Identifier">behaviourPenalty</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float64</span>
|
|
<span class="Identifier">overheadRateLimitOpt</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">TokenBucket</span><span class="Other">]</span>
|
|
<span class="Identifier">rpcmessagequeue</span><span class="Other">:</span> <a href="pubsubpeer.html#RpcMessageQueue"><span class="Identifier">RpcMessageQueue</span></a>
|
|
<span class="Identifier">maxNumElementsInNonPriorityQueue</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">disconnected</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L70"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="PubSubPeerEvent" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#PubSubPeerEvent"><span class="Identifier">PubSubPeerEvent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeerEventKind"><span class="Identifier">PubSubPeerEventKind</span></a>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L55"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="PubSubPeerEventKind" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#PubSubPeerEventKind"><span class="Identifier">PubSubPeerEventKind</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<span class="Identifier">StreamOpened</span><span class="Other">,</span> <span class="Identifier">StreamClosed</span><span class="Other">,</span> <span class="Identifier">DisconnectionRequested</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L50"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L50" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="RPCHandler" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#RPCHandler"><span class="Identifier">RPCHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
|
|
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L98"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L98" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="RpcMessageQueue" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#RpcMessageQueue"><span class="Identifier">RpcMessageQueue</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">sendPriorityQueue</span><span class="Other">:</span> <span class="Identifier">Deque</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="Other">]</span>
|
|
<span class="Identifier">nonPriorityQueue</span><span class="Other">:</span> <span class="Identifier">AsyncQueue</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="Identifier">sendNonPriorityTask</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L62"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L62" 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="DefaultMaxNumElementsInNonPriorityQueue" class="tohide">
|
|
<dt><pre><a href="pubsubpeer.html#DefaultMaxNumElementsInNonPriorityQueue"><span class="Identifier">DefaultMaxNumElementsInNonPriorityQueue</span></a> <span class="Other">=</span> <span class="DecNumber">1024</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L41"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L41" 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="==,PubSubPeer,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">func</span> <a href="#%3D%3D%2CPubSubPeer%2CPubSubPeer"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L123"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="canAskIWant,PubSubPeer,MessageId" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#canAskIWant%2CPubSubPeer%2CMessageId"><span class="Identifier">canAskIWant</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msgId</span><span class="Other">:</span> <a href="rpc/messages.html#MessageId"><span class="Identifier">MessageId</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L447"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L447" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="connect,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#connect%2CPubSubPeer"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L255"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L255" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="connected,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#connected%2CPubSubPeer"><span class="Identifier">connected</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L131"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getAgent,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getAgent%2CPubSubPeer"><span class="Identifier">getAgent</span></a><span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><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 class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L110"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L110" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="handle,PubSubPeer,Connection" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#handle%2CPubSubPeer%2CConnection"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">conn</span><span class="Other">:</span> <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L162"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L162" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">func</span> <a href="#hash%2CPubSubPeer"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Hash</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L120"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hasObservers,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hasObservers%2CPubSubPeer"><span class="Identifier">hasObservers</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L135"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hasSendConn,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hasSendConn%2CPubSubPeer"><span class="Identifier">hasSendConn</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L261"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L261" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="new,typedesc[PubSubPeer],PeerId,GetConn,OnEvent,string,int,int,Opt[TokenBucket]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BPubSubPeer%5D%2CPeerId%2CGetConn%2COnEvent%2Cstring%2Cint%2Cint%2COpt%5BTokenBucket%5D"><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="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">getConn</span><span class="Other">:</span> <a href="pubsubpeer.html#GetConn"><span class="Identifier">GetConn</span></a><span class="Other">;</span>
|
|
<span class="Identifier">onEvent</span><span class="Other">:</span> <a href="pubsubpeer.html#OnEvent"><span class="Identifier">OnEvent</span></a><span class="Other">;</span> <span class="Identifier">codec</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">maxMessageSize</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span>
|
|
<span class="Identifier">maxNumElementsInNonPriorityQueue</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Other">=</span> <span class="Identifier">DefaultMaxNumElementsInNonPriorityQueue</span><span class="Other">;</span>
|
|
<span class="Identifier">overheadRateLimitOpt</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">TokenBucket</span><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">Opt</span><span class="Other">.</span><span class="Identifier">none</span><span class="Other">(</span><span class="Identifier">TokenBucket</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L495"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L495" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="outbound,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">func</span> <a href="#outbound%2CPubSubPeer"><span class="Identifier">outbound</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L138"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L138" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="recvObservers,PubSubPeer,RPCMsg" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#recvObservers%2CPubSubPeer%2CRPCMsg"><span class="Identifier">recvObservers</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</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>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L148"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L148" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="send,PubSubPeer,RPCMsg,bool,bool" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#send%2CPubSubPeer%2CRPCMsg%2Cbool%2Cbool"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><span class="Other">;</span> <span class="Identifier">anonymize</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span> <span class="Identifier">isHighPriority</span><span class="Other">:</span> <span class="Identifier">bool</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">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 class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Asynchronously sends an <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt> to a specified <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt> with an option for anonymization.</p>
|
|
<p>Parameters:</p>
|
|
<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt> instance to which the message is to be sent.</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">RPCMsg</span></span></tt> instance representing the message to be sent.</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">anonymize</span></span></tt>: A boolean flag indicating whether the message should be sent with anonymization.</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">isHighPriority</span></span></tt>: A boolean flag indicating whether the message should be treated as high priority.</li>
|
|
</ul>
|
|
<p>High priority messages are sent immediately, while low priority messages are queued and sent only after all high priority messages have been sent.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L412"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L412" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sendEncoded,PubSubPeer,seq[byte],bool" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#sendEncoded%2CPubSubPeer%2Cseq%5Bbyte%5D%2Cbool"><span class="Identifier">sendEncoded</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">isHighPriority</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
|
<span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Asynchronously sends an encoded message to a specified <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt>.</p>
|
|
<p>Parameters:</p>
|
|
<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">PubSubPeer</span></span></tt> instance to which the message is to be sent.</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>: The message to be sent, encoded as a sequence of bytes (<tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">byte</span><span class="Punctuation">]</span></span></tt>).</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">isHighPriority</span></span></tt>: A boolean indicating whether the message should be treated as high priority.</li>
|
|
</ul>
|
|
<p>High priority messages are sent immediately, while low priority messages are queued and sent only after all high priority messages have been sent.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L331"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L331" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="shortLog,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">func</span> <a href="#shortLog%2CPubSubPeer"><span class="Identifier">shortLog</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><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 class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L126"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="stopSendNonPriorityTask,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#stopSendNonPriorityTask%2CPubSubPeer"><span class="Identifier">stopSendNonPriorityTask</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L477"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L477" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl></div>
|
|
<div class="section" id="18">
|
|
<h1><a class="toc-backref" href="#18">Templates</a></h1>
|
|
<dl class="item">
|
|
<div id="formatItIMPL.t,PubSubPeer" class="tohide">
|
|
<dt><pre><span class="Keyword">template</span> <a href="#formatItIMPL.t%2CPubSubPeer"><span class="Identifier">formatItIMPL</span></a><span class="Other">(</span><span class="Identifier">it</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/protocols/pubsub/pubsubpeer.nim#L129"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L129" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl></div>
|
|
<div class="section" id="19">
|
|
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
|
<dl class="item">
|
|
<a href="../../peerid.html#formatItIMPL.t,PeerId"><span class="Identifier">formatItIMPL</span></a>, <a href="../../peerid.html#hash.t,PeerId"><span class="Identifier">hash</span></a>, <a href="../../peerid.html#shortLog,PeerId"><span class="Identifier">shortLog</span></a>, <a href="../../peerid.html#random,typedesc[PeerId]"><span class="Identifier">random</span></a>, <a href="../../peerid.html#$,PeerId"><span class="Identifier">$</span></a>, <a href="../../peerid.html#write,VBuffer,PeerId"><span class="Identifier">write</span></a>, <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>, <a href="../../peerid.html#==.t,PeerId,PeerId"><span class="Identifier">==</span></a>, <a href="../../peerid.html#getField,ProtoBuffer,int,PeerId"><span class="Identifier">getField</span></a>, <a href="../../peerid.html#<=.t,PeerId,PeerId"><span class="Identifier"><=</span></a>, <a href="../../utility.html#capLen,seq[T],Natural"><span class="Identifier">capLen</span></a>, <a href="../../peerid.html#init,PeerId,string"><span class="Identifier">init</span></a>, <a href="../../peerid.html#validate,PeerId"><span class="Identifier">validate</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../peerid.html#match,PeerId,PrivateKey"><span class="Identifier">match</span></a>, <a href="../../peerid.html#<.t,PeerId,PeerId"><span class="Identifier"><</span></a>, <a href="../../peerid.html#getBytes.t,PeerId"><span class="Identifier">getBytes</span></a>, <a href="../../peerid.html#maxInlineKeyLength"><span class="Identifier">maxInlineKeyLength</span></a>, <a href="../../peerid.html#write,ProtoBuffer,int,PeerId"><span class="Identifier">write</span></a>, <a href="../../utility.html#withValue.t,,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="../../utility.html#safeConvert.t,S"><span class="Identifier">safeConvert</span></a>, <a href="../../utility.html#shortLog,openArray[byte]"><span class="Identifier">shortLog</span></a>, <a href="../../peerid.html#>=.t,PeerId,PeerId"><span class="Identifier">>=</span></a>, <a href="../../utility.html#withValue.m,,untyped,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="../../utility.html#public.t"><span class="Identifier">public</span></a>, <a href="../../utility.html#shortLog,string"><span class="Identifier">shortLog</span></a>, <a href="../../utility.html#compilesOr.t,untyped,untyped"><span class="Identifier">compilesOr</span></a>, <a href="../../peerid.html#toBytes,PeerId,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="../../peerid.html#match,PeerId,PublicKey"><span class="Identifier">match</span></a>, <a href="../../utility.html#valueOr.t,Option[T],untyped"><span class="Identifier">valueOr</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],string"><span class="Identifier">init</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],PublicKey"><span class="Identifier">init</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],PrivateKey"><span class="Identifier">init</span></a>, <a href="../../utility.html#toOpt.t,Result[T,E]"><span class="Identifier">toOpt</span></a>, <a href="../../peerid.html#init,PeerId,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../peerid.html#hasPublicKey,PeerId"><span class="Identifier">hasPublicKey</span></a>, <a href="../../peerid.html#>.t,PeerId,PeerId"><span class="Identifier">></span></a>, <a href="../../peerid.html#hex,PeerId"><span class="Identifier">hex</span></a>, <a href="../../peerid.html#len.t,PeerId"><span class="Identifier">len</span></a>, <a href="../../utility.html#exceptionToAssert.t,untyped"><span class="Identifier">exceptionToAssert</span></a>, <a href="../../peerid.html#cmp,PeerId,PeerId"><span class="Identifier">cmp</span></a>, <a href="../../peerid.html#extractPublicKey,PeerId,PublicKey"><span class="Identifier">extractPublicKey</span></a>, <a href="../../multiaddress.html#DNS_OR_IP"><span class="Identifier">DNS_OR_IP</span></a>, <a href="../../peerinfo.html#shortLog,PeerInfo"><span class="Identifier">shortLog</span></a>, <a href="../../crypto/crypto.html#random,typedesc[KeyPair],HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../multiaddress.html#UDP_DNS"><span class="Identifier">UDP_DNS</span></a>, <a href="../../crypto/crypto.html#$"><span class="Identifier">$</span></a>, <a href="../../protobuf/minprotobuf.html#getProtoHeader.t,int,ProtoFieldKind"><span class="Identifier">getProtoHeader</span></a>, <a href="../../multiaddress.html#MaError"><span class="Identifier">MaError</span></a>, <a href="../../crypto/ecnist.html#ephemeral,string,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="../../multiaddress.html#MaPatternOp"><span class="Identifier">MaPatternOp</span></a>, <a href="../../crypto/crypto.html#==,PublicKey,PublicKey"><span class="Identifier">==</span></a>, <a href="../../multiaddress.html#WS_DNS"><span class="Identifier">WS_DNS</span></a>, <a href="../../vbuffer.html#initVBuffer,seq[byte],int"><span class="Identifier">initVBuffer</span></a>, <a href="../../protobuf/minprotobuf.html#getProtoHeader.t,ProtoField"><span class="Identifier">getProtoHeader</span></a>, <a href="../../stream/lpstream.html#MaxSizeError"><span class="Identifier">MaxSizeError</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoHeader"><span class="Identifier">ProtoHeader</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoFlags"><span class="Identifier">ProtoFlags</span></a>, <a href="../../protobuf/minprotobuf.html#getLen.t,ProtoBuffer"><span class="Identifier">getLen</span></a>, <a href="../../crypto/ecnist.html#ECDHEScheme"><span class="Identifier">ECDHEScheme</span></a>, <a href="../../utility.html#shortLog,string_2"><span class="Identifier">shortLog</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],PublicKey_2"><span class="Identifier">init</span></a>, <a href="../../stream/lpstream.html#closed.e,LPStream"><span class="Identifier">closed</span></a>, <a href="../../multiaddress.html#[],MultiAddress,MultiCodec"><span class="Identifier">[]</span></a>, <a href="../../crypto/crypto.html#macOpenArray.t,Secret,int"><span class="Identifier">macOpenArray</span></a>, <a href="../../crypto/crypto.html#random,typedesc[KeyPair],PKScheme,HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],string"><span class="Identifier">init</span></a>, <a href="../../vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a>, <a href="../../crypto/crypto.html#Secret"><span class="Identifier">Secret</span></a>, <a href="../../vbuffer.html#peekVarint,VBuffer,LPSomeUVarint"><span class="Identifier">peekVarint</span></a>, <a href="../../peerid.html#random,typedesc[PeerId]_2"><span class="Identifier">random</span></a>, <a href="../../vbuffer.html#$,VBuffer"><span class="Identifier">$</span></a>, <a href="../../multiaddress.html#validate,MultiAddress"><span class="Identifier">validate</span></a>, <a href="../../multiaddress.html#bytes,MultiAddress"><span class="Identifier">bytes</span></a>, <a href="../../peerid.html#maxInlineKeyLength_2"><span class="Identifier">maxInlineKeyLength</span></a>, <a href="../../multiaddress.html#TranscoderDNS"><span class="Identifier">TranscoderDNS</span></a>, <a href="../../multiaddress.html#QUIC"><span class="Identifier">QUIC</span></a>, <a href="../../multiaddress.html#[],MultiAddress,HSlice"><span class="Identifier">[]</span></a>, <a href="../../crypto/crypto.html#init,Signature,string"><span class="Identifier">init</span></a>, <a href="../../crypto/ecnist.html#ephemeral,EcCurveKind,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="../../utility.html#withValue.m,,untyped,untyped,untyped_2"><span class="Identifier">withValue</span></a>, <a href="../../protobuf/minprotobuf.html#getRequiredField,ProtoBuffer,int,T"><span class="Identifier">getRequiredField</span></a>, <a href="../../crypto/crypto.html#getField,ProtoBuffer,int,T"><span class="Identifier">getField</span></a>, <a href="../../crypto/crypto.html#supported.t,PKScheme"><span class="Identifier">supported</span></a>, <a href="../../multiaddress.html#WS_IP"><span class="Identifier">WS_IP</span></a>, <a href="../../protobuf/minprotobuf.html#write,ProtoBuffer,int,openArray[T]"><span class="Identifier">write</span></a>, <a href="../../utility.html#public.t_2"><span class="Identifier">public</span></a>, <a href="../../multiaddress.html#MAKind"><span class="Identifier">MAKind</span></a>, <a href="../../peerid.html#write,ProtoBuffer,int,PeerId_2"><span class="Identifier">write</span></a>, <a href="../../protobuf/minprotobuf.html#checkFieldNumber.t,int"><span class="Identifier">checkFieldNumber</span></a>, <a href="../../utility.html#valueOr.t,Option[T],untyped_2"><span class="Identifier">valueOr</span></a>, <a href="../../protobuf/minprotobuf.html#getRepeatedField,ProtoBuffer,int,seq[T]"><span class="Identifier">getRepeatedField</span></a>, <a href="../../multiaddress.html#matchPartial,MaPattern,MultiAddress"><span class="Identifier">matchPartial</span></a>, <a href="../../crypto/crypto.html#libp2p_pki_schemes"><span class="Identifier">libp2p_pki_schemes</span></a>, <a href="../../crypto/crypto.html#getBytes,PublicKey"><span class="Identifier">getBytes</span></a>, <a href="../../peerid.html#len.t,PeerId_2"><span class="Identifier">len</span></a>, <a href="../../stream/lpstream.html#readVarint,LPStream"><span class="Identifier">readVarint</span></a>, <a href="../../stream/lpstream.html#readLp,LPStream,int"><span class="Identifier">readLp</span></a>, <a href="../../multiaddress.html#HTTP"><span class="Identifier">HTTP</span></a>, <a href="../../vbuffer.html#initVBuffer"><span class="Identifier">initVBuffer</span></a>, <a href="../../stream/lpstream.html#atEof.e,LPStream"><span class="Identifier">atEof</span></a>, <a href="../../stream/lpstream.html#LPStreamTrackerName"><span class="Identifier">LPStreamTrackerName</span></a>, <a href="../../stream/lpstream.html#write.e,LPStream,seq[byte]"><span class="Identifier">write</span></a>, <a href="../../utility.html#toOpt.t,Result[T,E]_2"><span class="Identifier">toOpt</span></a>, <a href="../../peerinfo.html#fullAddrs,PeerInfo"><span class="Identifier">fullAddrs</span></a>, <a href="../../routing_record.html#payloadType,typedesc[PeerRecord]"><span class="Identifier">payloadType</span></a>, <a href="../../peerid.html#<=.t,PeerId,PeerId_2"><span class="Identifier"><=</span></a>, <a href="../../stream/lpstream.html#LPStreamError"><span class="Identifier">LPStreamError</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#IP"><span class="Identifier">IP</span></a>, <a href="../../multiaddress.html#protoAddress,MultiAddress"><span class="Identifier">protoAddress</span></a>, <a href="../../crypto/crypto.html#newRng"><span class="Identifier">newRng</span></a>, <a href="../../stream/connection.html#DefaultConnectionTimeout"><span class="Identifier">DefaultConnectionTimeout</span></a>, <a href="../../crypto/crypto.html#==,PrivateKey,PrivateKey"><span class="Identifier">==</span></a>, <a href="../../routing_record.html#checkValid,SignedPeerRecord"><span class="Identifier">checkValid</span></a>, <a href="../../crypto/crypto.html#mac,Secret,int"><span class="Identifier">mac</span></a>, <a href="../../crypto/crypto.html#getPublicKey,PrivateKey"><span class="Identifier">getPublicKey</span></a>, <a href="../../utility.html#exceptionToAssert.t,untyped_2"><span class="Identifier">exceptionToAssert</span></a>, <a href="../../vbuffer.html#len,VBuffer"><span class="Identifier">len</span></a>, <a href="../../multiaddress.html#CircuitRelay"><span class="Identifier">CircuitRelay</span></a>, <a href="../../peerid.html#extractPublicKey,PeerId,PublicKey_2"><span class="Identifier">extractPublicKey</span></a>, <a href="../../multiaddress.html#mapAnd,varargs[MaPattern]"><span class="Identifier">mapAnd</span></a>, <a href="../../peerinfo.html#new,typedesc[PeerInfo],PrivateKey,openArray[MultiAddress],openArray[string],string,string"><span class="Identifier">new</span></a>, <a href="../../crypto/crypto.html#verify,Signature,openArray[byte],PublicKey"><span class="Identifier">verify</span></a>, <a href="../../multiaddress.html#UDP_IP"><span class="Identifier">UDP_IP</span></a>, <a href="../../stream/connection.html#new,typeConnection,PeerId,Direction,Opt[MultiAddress],Duration,TimeoutHandler"><span class="Identifier">new</span></a>, <a href="../../stream/lpstream.html#newLPStreamEOFError"><span class="Identifier">newLPStreamEOFError</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],string"><span class="Identifier">init</span></a>, <a href="../../peerid.html#==.t,PeerId,PeerId_2"><span class="Identifier">==</span></a>, <a href="../../multiaddress.html#DNSADDR"><span class="Identifier">DNSADDR</span></a>, <a href="../../peerinfo.html#AddressMapper"><span class="Identifier">AddressMapper</span></a>, <a href="../../crypto/crypto.html#init,typedesc[Signature],openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#write,VBuffer,PrivateKey"><span class="Identifier">write</span></a>, <a href="../../peerid.html#PeerId_2"><span class="Identifier">PeerId</span></a>, <a href="../../multiaddress.html#WSS"><span class="Identifier">WSS</span></a>, <a href="../../stream/lpstream.html#LPStream"><span class="Identifier">LPStream</span></a>, <a href="../../multiaddress.html#TCP_IP"><span class="Identifier">TCP_IP</span></a>, <a href="../../stream/lpstream.html#close.e,LPStream"><span class="Identifier">close</span></a>, <a href="../../protobuf/minprotobuf.html#writePacked,ProtoBuffer,int,openArray[T]"><span class="Identifier">writePacked</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress]"><span class="Identifier">init</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],openArray[byte]_2"><span class="Identifier">init</span></a>, <a href="../../stream/connection.html#closeImpl.e,Connection"><span class="Identifier">closeImpl</span></a>, <a href="../../vbuffer.html#readSeq,VBuffer,T"><span class="Identifier">readSeq</span></a>, <a href="../../crypto/crypto.html#toBytes,PrivateKey,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="../../multiaddress.html#TCP_DNS"><span class="Identifier">TCP_DNS</span></a>, <a href="../../stream/lpstream.html#shortLog,LPStream"><span class="Identifier">shortLog</span></a>, <a href="../../multiaddress.html#encode,typedesc[MultiBase],string,MultiAddress"><span class="Identifier">encode</span></a>, <a href="../../multiaddress.html#len,MultiAddress"><span class="Identifier">len</span></a>, <a href="../../utility.html#capLen,seq[T],Natural_2"><span class="Identifier">capLen</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],PrivateKey_2"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#protoName,MultiAddress"><span class="Identifier">protoName</span></a>, <a href="../../crypto/crypto.html#toRawBytes,,openArray[byte]"><span class="Identifier">toRawBytes</span></a>, <a href="../../multiaddress.html#mapOr,varargs[MaPattern]"><span class="Identifier">mapOr</span></a>, <a href="../../multiaddress.html#$,MaPattern"><span class="Identifier">$</span></a>, <a href="../../protobuf/minprotobuf.html#initProtoBuffer,openArray[byte],int,set[ProtoFlags]"><span class="Identifier">initProtoBuffer</span></a>, <a href="../../routing_record.html#init,typedesc[PeerRecord],PeerId,seq[MultiAddress]"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#WSS_DNS"><span class="Identifier">WSS_DNS</span></a>, <a href="../../peerid.html#match,PeerId,PrivateKey_2"><span class="Identifier">match</span></a>, <a href="../../vbuffer.html#writeLPVarint,VBuffer,LPSomeUVarint"><span class="Identifier">writeLPVarint</span></a>, <a href="../../crypto/crypto.html#CryptoResult"><span class="Identifier">CryptoResult</span></a>, <a href="../../peerinfo.html#parseFullAddress,MultiAddress"><span class="Identifier">parseFullAddress</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoResult"><span class="Identifier">ProtoResult</span></a>, <a href="../../multiaddress.html#WebRTCDirect"><span class="Identifier">WebRTCDirect</span></a>, <a href="../../peerid.html#init,typedesc[PeerId],string_2"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#init,PublicKey,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#UDP"><span class="Identifier">UDP</span></a>, <a href="../../multiaddress.html#TranscoderOnion"><span class="Identifier">TranscoderOnion</span></a>, <a href="../../stream/lpstream.html#StreamTracker"><span class="Identifier">StreamTracker</span></a>, <a href="../../protobuf/minprotobuf.html#write,ProtoBuffer,int,ProtoBuffer"><span class="Identifier">write</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],"><span class="Identifier">init</span></a>, <a href="../../stream/lpstream.html#LPStreamResetError"><span class="Identifier">LPStreamResetError</span></a>, <a href="../../vbuffer.html#isEmpty.t,VBuffer"><span class="Identifier">isEmpty</span></a>, <a href="../../vbuffer.html#writeArray,VBuffer,openArray[T]"><span class="Identifier">writeArray</span></a>, <a href="../../signed_envelope.html#decode,typedesc[Envelope],seq[byte],string"><span class="Identifier">decode</span></a>, <a href="../../stream/lpstream.html#LPStreamIncompleteError"><span class="Identifier">LPStreamIncompleteError</span></a>, <a href="../../multiaddress.html#[],MultiAddress,"><span class="Identifier">[]</span></a>, <a href="../../stream/lpstream.html#LPStreamEOFError"><span class="Identifier">LPStreamEOFError</span></a>, <a href="../../multiaddress.html#IP6"><span class="Identifier">IP6</span></a>, <a href="../../peerid.html#shortLog,PeerId_2"><span class="Identifier">shortLog</span></a>, <a href="../../vbuffer.html#initVBuffer,openArray[byte],int"><span class="Identifier">initVBuffer</span></a>, <a href="../../signed_envelope.html#decode,typedesc[SignedPayload[T]],seq[byte]"><span class="Identifier">decode</span></a>, <a href="../../crypto/crypto.html#PKScheme"><span class="Identifier">PKScheme</span></a>, <a href="../../multiaddress.html#toString,MultiAddress"><span class="Identifier">toString</span></a>, <a href="../../signed_envelope.html#payload,Envelope"><span class="Identifier">payload</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],SkPrivateKey"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#stretchKeys,string,string,seq[byte]"><span class="Identifier">stretchKeys</span></a>, <a href="../../stream/connection.html#Connection"><span class="Identifier">Connection</span></a>, <a href="../../peerid.html#write,VBuffer,PeerId_2"><span class="Identifier">write</span></a>, <a href="../../multiaddress.html#DNSANY"><span class="Identifier">DNSANY</span></a>, <a href="../../multiaddress.html#TCP"><span class="Identifier">TCP</span></a>, <a href="../../crypto/crypto.html#PrivateKey"><span class="Identifier">PrivateKey</span></a>, <a href="../../peerid.html#getBytes.t,PeerId_2"><span class="Identifier">getBytes</span></a>, <a href="../../protobuf/minprotobuf.html#write,ProtoBuffer,int,T"><span class="Identifier">write</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],_2"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#&=,MultiAddress,MultiAddress"><span class="Identifier">&=</span></a>, <a href="../../peerinfo.html#PeerInfoError"><span class="Identifier">PeerInfoError</span></a>, <a href="../../peerid.html#hash.t,PeerId_2"><span class="Identifier">hash</span></a>, <a href="../../stream/lpstream.html#newLPStreamClosedError"><span class="Identifier">newLPStreamClosedError</span></a>, <a href="../../crypto/crypto.html#random,typedesc[PrivateKey],HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../crypto/crypto.html#write,ProtoBuffer,int,Signature"><span class="Identifier">write</span></a>, <a href="../../utility.html#compilesOr.t,untyped,untyped_2"><span class="Identifier">compilesOr</span></a>, <a href="../../multiaddress.html#TranscoderIP4"><span class="Identifier">TranscoderIP4</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],"><span class="Identifier">init</span></a>, <a href="../../protobuf/minprotobuf.html#initProtoBuffer,set[ProtoFlags]"><span class="Identifier">initProtoBuffer</span></a>, <a href="../../errors.html#toException,string"><span class="Identifier">toException</span></a>, <a href="../../multiaddress.html#DNS"><span class="Identifier">DNS</span></a>, <a href="../../multiaddress.html#UTP"><span class="Identifier">UTP</span></a>, <a href="../../crypto/crypto.html#goffset.t,untyped,untyped,untyped"><span class="Identifier">goffset</span></a>, <a href="../../crypto/crypto.html#getRawBytes"><span class="Identifier">getRawBytes</span></a>, <a href="../../peerid.html#>.t,PeerId,PeerId_2"><span class="Identifier">></span></a>, <a href="../../crypto/crypto.html#KeyPair"><span class="Identifier">KeyPair</span></a>, <a href="../../peerid.html#init,PeerId,string_2"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#init,PrivateKey,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../vbuffer.html#high,VBuffer"><span class="Identifier">high</span></a>, <a href="../../peerid.html#cmp,PeerId,PeerId_2"><span class="Identifier">cmp</span></a>, <a href="../../signed_envelope.html#init,typedesc[SignedPayload[T]],PrivateKey,T"><span class="Identifier">init</span></a>, <a href="../../protobuf/minprotobuf.html#SupportedWireTypes"><span class="Identifier">SupportedWireTypes</span></a>, <a href="../../stream/lpstream.html#formatItIMPL.t,LPStream"><span class="Identifier">formatItIMPL</span></a>, <a href="../../peerid.html#formatItIMPL.t,PeerId_2"><span class="Identifier">formatItIMPL</span></a>, <a href="../../peerinfo.html#formatItIMPL.t,PeerInfo"><span class="Identifier">formatItIMPL</span></a>, <a href="../../crypto/crypto.html#Signature"><span class="Identifier">Signature</span></a>, <a href="../../multiaddress.html#contains,MultiAddress,MultiCodec"><span class="Identifier">contains</span></a>, <a href="../../stream/connection.html#formatItIMPL.t,Connection"><span class="Identifier">formatItIMPL</span></a>, <a href="../../peerid.html#toBytes,PeerId,openArray[byte]_2"><span class="Identifier">toBytes</span></a>, <a href="../../crypto/crypto.html#DigestSheme"><span class="Identifier">DigestSheme</span></a>, <a href="../../multiaddress.html#IPFS"><span class="Identifier">IPFS</span></a>, <a href="../../protobuf/minprotobuf.html#getField,ProtoBuffer,int,T_2"><span class="Identifier">getField</span></a>, <a href="../../stream/lpstream.html#readOnce.e,LPStream,pointer,int"><span class="Identifier">readOnce</span></a>, <a href="../../protobuf/minprotobuf.html#isEmpty.t,ProtoBuffer"><span class="Identifier">isEmpty</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoScalar"><span class="Identifier">ProtoScalar</span></a>, <a href="../../utility.html#shortLog,openArray[byte]_2"><span class="Identifier">shortLog</span></a>, <a href="../../multiaddress.html#data,MultiAddress"><span class="Identifier">data</span></a>, <a href="../../peerid.html#hex,PeerId_2"><span class="Identifier">hex</span></a>, <a href="../../multiaddress.html#protocols,MultiAddress"><span class="Identifier">protocols</span></a>, <a href="../../multiaddress.html#HTTPS"><span class="Identifier">HTTPS</span></a>, <a href="../../multiaddress.html#WebSockets"><span class="Identifier">WebSockets</span></a>, <a href="../../errors.html#LPError"><span class="Identifier">LPError</span></a>, <a href="../../protobuf/minprotobuf.html#getPtr.t,ProtoBuffer"><span class="Identifier">getPtr</span></a>, <a href="../../multiaddress.html#write,ProtoBuffer,int,MultiAddress"><span class="Identifier">write</span></a>, <a href="../../multiaddress.html#TLS_WS"><span class="Identifier">TLS_WS</span></a>, <a href="../../crypto/crypto.html#sign,PrivateKey,openArray[byte]"><span class="Identifier">sign</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../signed_envelope.html#encode,SignedPayload[T]"><span class="Identifier">encode</span></a>, <a href="../../peerinfo.html#update,PeerInfo"><span class="Identifier">update</span></a>, <a href="../../multiaddress.html#MaResult"><span class="Identifier">MaResult</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoField"><span class="Identifier">ProtoField</span></a>, <a href="../../crypto/crypto.html#toBytes,PublicKey,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="../../vbuffer.html#writeSeq,VBuffer,openArray[T]"><span class="Identifier">writeSeq</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],SkPublicKey"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#&,MultiAddress,MultiAddress"><span class="Identifier">&</span></a>, <a href="../../multiaddress.html#DNS6"><span class="Identifier">DNS6</span></a>, <a href="../../multiaddress.html#IpTransportProtocol"><span class="Identifier">IpTransportProtocol</span></a>, <a href="../../protobuf/minprotobuf.html#toOpenArray.t,ProtoBuffer"><span class="Identifier">toOpenArray</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],MultiCodec,PeerId"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#IP4"><span class="Identifier">IP4</span></a>, <a href="../../multiaddress.html#TranscoderPort"><span class="Identifier">TranscoderPort</span></a>, <a href="../../vbuffer.html#isEnough.t,VBuffer,int"><span class="Identifier">isEnough</span></a>, <a href="../../utility.html#safeConvert.t,S_2"><span class="Identifier">safeConvert</span></a>, <a href="../../multiaddress.html#getField,ProtoBuffer,int,MultiAddress"><span class="Identifier">getField</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],_2"><span class="Identifier">init</span></a>, <a href="../../peerid.html#>=.t,PeerId,PeerId_2"><span class="Identifier">>=</span></a>, <a href="../../vbuffer.html#readVarint,VBuffer,LPSomeUVarint"><span class="Identifier">readVarint</span></a>, <a href="../../routing_record.html#payloadDomain,typedesc[PeerRecord]"><span class="Identifier">payloadDomain</span></a>, <a href="../../crypto/crypto.html#$,Signature"><span class="Identifier">$</span></a>, <a href="../../multiaddress.html#MaPattern"><span class="Identifier">MaPattern</span></a>, <a href="../../utility.html#withValue.t,,untyped,untyped_2"><span class="Identifier">withValue</span></a>, <a href="../../stream/lpstream.html#LPStreamLimitError"><span class="Identifier">LPStreamLimitError</span></a>, <a href="../../multiaddress.html#TranscoderOnion3"><span class="Identifier">TranscoderOnion3</span></a>, <a href="../../signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a>, <a href="../../crypto/crypto.html#toBytes,Signature,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="../../multiaddress.html#protoArgument,MultiAddress,openArray[byte]"><span class="Identifier">protoArgument</span></a>, <a href="../../stream/lpstream.html#newLPStreamLimitError"><span class="Identifier">newLPStreamLimitError</span></a>, <a href="../../signed_envelope.html#write,ProtoBuffer,int,Envelope"><span class="Identifier">write</span></a>, <a href="../../crypto/crypto.html#keyOpenArray.t,Secret,int"><span class="Identifier">keyOpenArray</span></a>, <a href="../../peerid.html#match,PeerId,PublicKey_2"><span class="Identifier">match</span></a>, <a href="../../peerinfo.html#parseFullAddress"><span class="Identifier">parseFullAddress</span></a>, <a href="../../multiaddress.html#$,MultiAddress"><span class="Identifier">$</span></a>, <a href="../../multiaddress.html#isEmpty,MultiAddress"><span class="Identifier">isEmpty</span></a>, <a href="../../stream/lpstream.html#writeLp,LPStream,openArray[byte]"><span class="Identifier">writeLp</span></a>, <a href="../../protobuf/minprotobuf.html#getRequiredRepeatedField,ProtoBuffer,int,seq[T]"><span class="Identifier">getRequiredRepeatedField</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PublicKey],EdPublicKey"><span class="Identifier">init</span></a>, <a href="../../stream/lpstream.html#newLPStreamIncompleteError"><span class="Identifier">newLPStreamIncompleteError</span></a>, <a href="../../protobuf/minprotobuf.html#initProtoBuffer,seq[byte],int,set[ProtoFlags]"><span class="Identifier">initProtoBuffer</span></a>, <a href="../../multiaddress.html#MAProtocol"><span class="Identifier">MAProtocol</span></a>, <a href="../../stream/lpstream.html#newLPStreamResetError"><span class="Identifier">newLPStreamResetError</span></a>, <a href="../../protobuf/minprotobuf.html#getPackedRepeatedField,ProtoBuffer,int,seq[T]"><span class="Identifier">getPackedRepeatedField</span></a>, <a href="../../stream/connection.html#initStream.e,Connection"><span class="Identifier">initStream</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],MultiCodec,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../protobuf/minprotobuf.html#getField,ProtoBuffer,int,openArray[T],int"><span class="Identifier">getField</span></a>, <a href="../../stream/connection.html#shortLog,Connection"><span class="Identifier">shortLog</span></a>, <a href="../../multiaddress.html#DNS4"><span class="Identifier">DNS4</span></a>, <a href="../../stream/connection.html#getWrapped.e,Connection"><span class="Identifier">getWrapped</span></a>, <a href="../../vbuffer.html#readArray,VBuffer,openArray[T]"><span class="Identifier">readArray</span></a>, <a href="../../crypto/crypto.html#selectBest,int,string,string"><span class="Identifier">selectBest</span></a>, <a href="../../crypto/crypto.html#write,VBuffer,PrivateKey_2"><span class="Identifier">write</span></a>, <a href="../../multiaddress.html#P2PPattern"><span class="Identifier">P2PPattern</span></a>, <a href="../../signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a>, <a href="../../peerid.html#hasPublicKey,PeerId_2"><span class="Identifier">hasPublicKey</span></a>, <a href="../../errors.html#toException,cstring"><span class="Identifier">toException</span></a>, <a href="../../protobuf/minprotobuf.html#isEnough.t,ProtoBuffer,int"><span class="Identifier">isEnough</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],IpAddress,IpTransportProtocol,Port"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#Reliable"><span class="Identifier">Reliable</span></a>, <a href="../../peerinfo.html#addrs,PeerInfo"><span class="Identifier">addrs</span></a>, <a href="../../multiaddress.html#hex,MultiAddress"><span class="Identifier">hex</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoBuffer"><span class="Identifier">ProtoBuffer</span></a>, <a href="../../stream/lpstream.html#closeImpl.e,LPStream"><span class="Identifier">closeImpl</span></a>, <a href="../../crypto/crypto.html#getBytes,PrivateKey"><span class="Identifier">getBytes</span></a>, <a href="../../multiaddress.html#WS"><span class="Identifier">WS</span></a>, <a href="../../crypto/crypto.html#init,T,string"><span class="Identifier">init</span></a>, <a href="../../peerid.html#init,PeerId,openArray[byte]_2"><span class="Identifier">init</span></a>, <a href="../../routing_record.html#encode,PeerRecord"><span class="Identifier">encode</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],TransportAddress"><span class="Identifier">init</span></a>, <a href="../../protobuf/minprotobuf.html#finish,ProtoBuffer"><span class="Identifier">finish</span></a>, <a href="../../peerid.html#getField,ProtoBuffer,int,PeerId_2"><span class="Identifier">getField</span></a>, <a href="../../multiaddress.html#match,MaPattern,MultiAddress"><span class="Identifier">match</span></a>, <a href="../../peerid.html#<.t,PeerId,PeerId_2"><span class="Identifier"><</span></a>, <a href="../../crypto/crypto.html#iv,Secret,int"><span class="Identifier">iv</span></a>, <a href="../../stream/lpstream.html#readLine,LPStream,int,string"><span class="Identifier">readLine</span></a>, <a href="../../stream/lpstream.html#Eof"><span class="Identifier">Eof</span></a>, <a href="../../crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a>, <a href="../../signed_envelope.html#getField,ProtoBuffer,int,Envelope,string"><span class="Identifier">getField</span></a>, <a href="../../stream/connection.html#hash,Connection"><span class="Identifier">hash</span></a>, <a href="../../multiaddress.html#append,MultiAddress,MultiAddress"><span class="Identifier">append</span></a>, <a href="../../protobuf/minprotobuf.html#vsizeof,ProtoField"><span class="Identifier">vsizeof</span></a>, <a href="../../crypto/crypto.html#init,Signature,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../../multiaddress.html#WebSockets_DNS"><span class="Identifier">WebSockets_DNS</span></a>, <a href="../../multiaddress.html#WSS_IP"><span class="Identifier">WSS_IP</span></a>, <a href="../../stream/lpstream.html#LPStreamConnDownError"><span class="Identifier">LPStreamConnDownError</span></a>, <a href="../../vbuffer.html#peekArray,VBuffer,openArray[T]"><span class="Identifier">peekArray</span></a>, <a href="../../multiaddress.html#UNIX"><span class="Identifier">UNIX</span></a>, <a href="../../routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a>, <a href="../../crypto/crypto.html#SupportedSchemes"><span class="Identifier">SupportedSchemes</span></a>, <a href="../../protobuf/minprotobuf.html#getRepeatedField,ProtoBuffer,int,seq[T]_2"><span class="Identifier">getRepeatedField</span></a>, <a href="../../crypto/crypto.html#getField,ProtoBuffer,int,Signature"><span class="Identifier">getField</span></a>, <a href="../../multiaddress.html#Unreliable"><span class="Identifier">Unreliable</span></a>, <a href="../../crypto/crypto.html#SupportedSchemesInt"><span class="Identifier">SupportedSchemesInt</span></a>, <a href="../../crypto/crypto.html#random,typedesc[PrivateKey],PKScheme,HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../../errors.html#checkFutures.m,seq[F],untyped"><span class="Identifier">checkFutures</span></a>, <a href="../../crypto/crypto.html#shuffle,ref.HmacDrbgContext,openArray[T]"><span class="Identifier">shuffle</span></a>, <a href="../../crypto/crypto.html#key,Secret,int"><span class="Identifier">key</span></a>, <a href="../../peerid.html#validate,PeerId_2"><span class="Identifier">validate</span></a>, <a href="../../peerid.html#$,PeerId_2"><span class="Identifier">$</span></a>, <a href="../../multiaddress.html#protoCode,MultiAddress"><span class="Identifier">protoCode</span></a>, <a href="../../multiaddress.html#mapEq,string"><span class="Identifier">mapEq</span></a>, <a href="../../protobuf/minprotobuf.html#getField,ProtoBuffer,int,T_3"><span class="Identifier">getField</span></a>, <a href="../../multiaddress.html#Onion3"><span class="Identifier">Onion3</span></a>, <a href="../../crypto/crypto.html#write,ProtoBuffer,int,T_2"><span class="Identifier">write</span></a>, <a href="../../multiaddress.html#TcpOnion3"><span class="Identifier">TcpOnion3</span></a>, <a href="../../multiaddress.html#concat,MultiAddress,MultiAddress"><span class="Identifier">concat</span></a>, <a href="../../multiaddress.html#TranscoderP2P"><span class="Identifier">TranscoderP2P</span></a>, <a href="../../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a>, <a href="../../routing_record.html#AddressInfo"><span class="Identifier">AddressInfo</span></a>, <a href="../../stream/connection.html#ConnectionTrackerName"><span class="Identifier">ConnectionTrackerName</span></a>, <a href="../../multiaddress.html#TranscoderIP6"><span class="Identifier">TranscoderIP6</span></a>, <a href="../../vbuffer.html#finish,VBuffer"><span class="Identifier">finish</span></a>, <a href="../../multiaddress.html#write,VBuffer,MultiAddress"><span class="Identifier">write</span></a>, <a href="../../signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</span></a>, <a href="../../multiaddress.html#hash,MultiAddress"><span class="Identifier">hash</span></a>, <a href="../../signed_envelope.html#encode,Envelope"><span class="Identifier">encode</span></a>, <a href="../../stream/lpstream.html#newLPStreamRemoteClosedError"><span class="Identifier">newLPStreamRemoteClosedError</span></a>, <a href="../../multiaddress.html#TranscoderIP6Zone"><span class="Identifier">TranscoderIP6Zone</span></a>, <a href="../../multiaddress.html#MaPatResult"><span class="Identifier">MaPatResult</span></a>, <a href="../../stream/lpstream.html#Direction"><span class="Identifier">Direction</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],EdPrivateKey"><span class="Identifier">init</span></a>, <a href="../../stream/lpstream.html#InvalidVarintError"><span class="Identifier">InvalidVarintError</span></a>, <a href="../../routing_record.html#decode,typedesc[PeerRecord],seq[byte]"><span class="Identifier">decode</span></a>, <a href="../../crypto/crypto.html#shortLog"><span class="Identifier">shortLog</span></a>, <a href="../../multiaddress.html#items.i,MultiAddress"><span class="Identifier">items</span></a>, <a href="../../multiaddress.html#==,MultiAddress,MultiAddress"><span class="Identifier">==</span></a>, <a href="../../crypto/crypto.html#init,typedesc[PrivateKey],string"><span class="Identifier">init</span></a>, <a href="../../vbuffer.html#peekSeq,VBuffer,T"><span class="Identifier">peekSeq</span></a>, <a href="../../crypto/crypto.html#getBytes,Signature"><span class="Identifier">getBytes</span></a>, <a href="../../stream/lpstream.html#write,LPStream,string"><span class="Identifier">write</span></a>, <a href="../../multiaddress.html#init,typedesc[MultiAddress],MultiCodec,int"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#init,typedesc[Signature],string"><span class="Identifier">init</span></a>, <a href="../../signed_envelope.html#init,typedesc[Envelope],PrivateKey,seq[byte],seq[byte],string"><span class="Identifier">init</span></a>, <a href="../../crypto/crypto.html#PublicKey"><span class="Identifier">PublicKey</span></a>, <a href="../../multiaddress.html#WebSockets_IP"><span class="Identifier">WebSockets_IP</span></a>, <a href="../../stream/lpstream.html#writeLp,LPStream,string"><span class="Identifier">writeLp</span></a>, <a href="../../vbuffer.html#writePBVarint,VBuffer,PBSomeUVarint"><span class="Identifier">writePBVarint</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoFieldKind"><span class="Identifier">ProtoFieldKind</span></a>, <a href="../../stream/lpstream.html#readExactly,LPStream,pointer,int"><span class="Identifier">readExactly</span></a>, <a href="../../multiaddress.html#protoArgument,MultiAddress"><span class="Identifier">protoArgument</span></a>, <a href="../../multiaddress.html#getRepeatedField,ProtoBuffer,int,seq[MultiAddress]"><span class="Identifier">getRepeatedField</span></a>, <a href="../../protobuf/minprotobuf.html#ProtoError"><span class="Identifier">ProtoError</span></a>, <a href="../../stream/lpstream.html#newLPStreamConnDownError,ref.Exception"><span class="Identifier">newLPStreamConnDownError</span></a>, <a href="../../stream/lpstream.html#initStream.e,LPStream"><span class="Identifier">initStream</span></a>, <a href="../../protobuf/minprotobuf.html#getField,ProtoBuffer,int,ProtoBuffer"><span class="Identifier">getField</span></a>, <a href="../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a>, <a href="../../crypto/crypto.html#ivOpenArray.t,Secret,int"><span class="Identifier">ivOpenArray</span></a>, <a href="../../stream/lpstream.html#closeWithEOF,LPStream"><span class="Identifier">closeWithEOF</span></a>, <a href="../../stream/connection.html#TimeoutHandler"><span class="Identifier">TimeoutHandler</span></a>, <a href="../../crypto/crypto.html#orError.t,untyped,untyped"><span class="Identifier">orError</span></a>, <a href="../../signed_envelope.html#getField,ProtoBuffer,int,SignedPayload[T]"><span class="Identifier">getField</span></a>, <a href="../../stream/lpstream.html#LPStreamRemoteClosedError"><span class="Identifier">LPStreamRemoteClosedError</span></a>, <a href="../../multiaddress.html#MaInvalidAddress"><span class="Identifier">MaInvalidAddress</span></a>, <a href="../../stream/lpstream.html#LPStreamClosedError"><span class="Identifier">LPStreamClosedError</span></a>, <a href="../../crypto/crypto.html#RsaDefaultKeySize"><span class="Identifier">RsaDefaultKeySize</span></a>, <a href="../../crypto/crypto.html#write,VBuffer,PublicKey"><span class="Identifier">write</span></a>, <a href="../../crypto/crypto.html#getOrder,openArray[byte],openArray[byte],openArray[byte],openArray[byte]"><span class="Identifier">getOrder</span></a>, <a href="../../multiaddress.html#TranscoderUnix"><span class="Identifier">TranscoderUnix</span></a>, <a href="../../routing_record.html#SignedPeerRecord"><span class="Identifier">SignedPeerRecord</span></a>, <a href="../../stream/lpstream.html#join,LPStream"><span class="Identifier">join</span></a>, <a href="../../vbuffer.html#writeVarint,VBuffer,LPSomeUVarint"><span class="Identifier">writeVarint</span></a>
|
|
</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: 2024-06-04 19:44:01 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|