2024-01-31 17:42:35 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8" ?>
|
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
<!-- This file is generated by Nim. -->
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
|
|
|
|
<!-- Favicon -->
|
|
|
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
|
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
|
|
|
|
|
|
|
|
|
<!-- Google fonts -->
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
|
|
|
|
|
|
<!-- CSS -->
|
|
|
|
|
<title>libp2p/protocols/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[MessageId]]
|
|
|
|
|
iHaveBudget*: int
|
|
|
|
|
pingBudget*: int
|
|
|
|
|
maxMessageSize: int
|
|
|
|
|
appScore*: float64
|
|
|
|
|
behaviourPenalty*: float64
|
|
|
|
|
overheadRateLimitOpt*: Opt[TokenBucket]
|
2024-02-13 12:18:41 +00:00
|
|
|
rpcmessagequeue*: RpcMessageQueue">PubSubPeer</a></li>
|
2024-01-31 17:42:35 +00:00
|
|
|
<li><a class="reference" href="#PubSubPeerEvent"
|
|
|
|
|
title="PubSubPeerEvent = object
|
|
|
|
|
kind*: PubSubPeerEventKind">PubSubPeerEvent</a></li>
|
|
|
|
|
<li><a class="reference" href="#PubSubPeerEventKind"
|
|
|
|
|
title="PubSubPeerEventKind {.pure.} = enum
|
|
|
|
|
Connected, Disconnected">PubSubPeerEventKind</a></li>
|
2024-02-01 16:48:48 +00:00
|
|
|
<li><a class="reference" href="#QueuedMessage"
|
|
|
|
|
title="QueuedMessage = object
|
|
|
|
|
msg*: seq[byte]
|
|
|
|
|
addedAt*: Moment">QueuedMessage</a></li>
|
2024-01-31 17:42:35 +00:00
|
|
|
<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]]
|
2024-02-01 16:48:48 +00:00
|
|
|
nonPriorityQueue: AsyncQueue[QueuedMessage]
|
2024-01-31 17:42:35 +00:00
|
|
|
sendNonPriorityTask: Future[void]
|
2024-02-13 12:18:41 +00:00
|
|
|
maxDurationInNonPriorityQueue*: Opt[Duration]">RpcMessageQueue</a></li>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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%2COpt%5BTokenBucket%5D"
|
|
|
|
|
title="new(T: typedesc[PubSubPeer]; peerId: PeerId; getConn: GetConn; onEvent: OnEvent;
|
|
|
|
|
codec: string; maxMessageSize: int;
|
2024-02-13 12:18:41 +00:00
|
|
|
overheadRateLimitOpt: Opt[TokenBucket] = Opt.none(TokenBucket);
|
|
|
|
|
maxDurationInNonPriorityQueue = Opt.none(Duration)): T:type">new(T: typedesc[PubSubPeer]; peerId: PeerId; getConn: GetConn; onEvent: OnEvent;
|
2024-01-31 17:42:35 +00:00
|
|
|
codec: string; maxMessageSize: int;
|
2024-02-13 12:18:41 +00:00
|
|
|
overheadRateLimitOpt: Opt[TokenBucket] = Opt.none(TokenBucket);
|
|
|
|
|
maxDurationInNonPriorityQueue = Opt.none(Duration)): T:type</a></li>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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 = false): Future[
|
|
|
|
|
void]">send(p: PubSubPeer; msg: RPCMsg; anonymize: bool; isHighPriority: bool = false): Future[
|
|
|
|
|
void]</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 = false): Future[
|
|
|
|
|
void]">sendEncoded(p: PubSubPeer; msg: seq[byte]; isHighPriority: bool = false): 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/drop-old-relayed-msgs/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">
|
2024-02-09 11:05:00 +00:00
|
|
|
<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>
|
2024-01-31 17:42:35 +00:00
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L55"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L54"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L56"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L41"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L43"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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#MessageId"><span class="Identifier">MessageId</span></a><span class="Other">]</span><span class="Other">]</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>
|
2024-02-13 12:18:41 +00:00
|
|
|
<span class="Identifier">rpcmessagequeue</span><span class="Operator">*</span><span class="Other">:</span> <a href="pubsubpeer.html#RpcMessageQueue"><span class="Identifier">RpcMessageQueue</span></a>
|
2024-01-31 17:42:35 +00:00
|
|
|
</pre></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L72"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L51"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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">Connected</span><span class="Other">,</span> <span class="Identifier">Disconnected</span></pre></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L47"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
2024-02-01 16:48:48 +00:00
|
|
|
</dd>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="QueuedMessage" class="tohide">
|
|
|
|
|
<dt><pre><a href="pubsubpeer.html#QueuedMessage"><span class="Identifier">QueuedMessage</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
|
|
|
<span class="Identifier">msg</span><span class="Operator">*</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="Identifier">addedAt</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Moment</span>
|
|
|
|
|
</pre></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L58"
|
2024-02-01 16:48:48 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
|
2024-02-01 16:48:48 +00:00
|
|
|
|
2024-01-31 17:42:35 +00:00
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L95"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L95" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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>
|
2024-02-01 16:48:48 +00:00
|
|
|
<span class="Identifier">nonPriorityQueue</span><span class="Other">:</span> <span class="Identifier">AsyncQueue</span><span class="Other">[</span><a href="pubsubpeer.html#QueuedMessage"><span class="Identifier">QueuedMessage</span></a><span class="Other">]</span>
|
2024-01-31 17:42:35 +00:00
|
|
|
<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>
|
2024-02-13 12:18:41 +00:00
|
|
|
<span class="Identifier">maxDurationInNonPriorityQueue</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">Duration</span><span class="Other">]</span>
|
2024-01-31 17:42:35 +00:00
|
|
|
</pre></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L62"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L120"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-13 12:21:19 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L378"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-13 12:21:19 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L378" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L246"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L246" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L128"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L128" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L107"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L107" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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">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">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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L159"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L159" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L117"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L117" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L132"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L132" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L252"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L252" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="new,typedesc[PubSubPeer],PeerId,GetConn,OnEvent,string,int,Opt[TokenBucket]" class="tohide">
|
|
|
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BPubSubPeer%5D%2CPeerId%2CGetConn%2COnEvent%2Cstring%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>
|
2024-02-13 12:18:41 +00:00
|
|
|
<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="Identifier">maxDurationInNonPriorityQueue</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">Duration</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.
|
2024-01-31 17:42:35 +00:00
|
|
|
<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
|
2024-02-13 12:21:19 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L428"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-13 12:21:19 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L428" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L135"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L145"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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 class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
|
|
|
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="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">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
|
2024-02-13 12:21:19 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L352"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-13 12:21:19 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L352" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
|
|
|
|
|
<span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="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">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
|
2024-02-13 12:21:19 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L293"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-13 12:21:19 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L293" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L123"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-13 12:21:19 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L410"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-13 12:21:19 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L410" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</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
|
2024-02-09 11:05:00 +00:00
|
|
|
href="https://github.com/status-im/nim-libp2p/tree/drop-old-relayed-msgs/libp2p/protocols/pubsub/pubsubpeer.nim#L126"
|
2024-01-31 17:42:35 +00:00
|
|
|
class="link-seesrc" target="_blank">Source</a>
|
2024-02-09 11:05:00 +00:00
|
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/pubsubpeer.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
|
2024-01-31 17:42:35 +00:00
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</dl></div>
|
|
|
|
|
<div class="section" id="19">
|
|
|
|
|
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
|
|
|
|
<dl class="item">
|
2024-02-09 11:05:00 +00:00
|
|
|
<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="../../stream/lpstream.html#newLPStreamWriteError,ref.CatchableError"><span class="Identi
|
2024-01-31 17:42:35 +00:00
|
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="row">
|
|
|
|
|
<div class="twelve-columns footer">
|
|
|
|
|
<span class="nim-sprite"></span>
|
|
|
|
|
<br/>
|
2024-02-13 18:08:56 +00:00
|
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-13 18:08:49 UTC</small>
|
2024-01-31 17:42:35 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
