status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-libp2p/formatting/libp2p/protocols/pubsub/gossipsub/behavior.html

505 lines
37 KiB
HTML
Raw Normal View History

update docs for formatting
2024-06-06 12:45:18 +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/gossipsub/behavior</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/gossipsub/behavior</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../../../../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">dropFanoutPeers
<li><a class="reference" href="#dropFanoutPeers%2CGossipSub"
title="dropFanoutPeers(g: GossipSub)">dropFanoutPeers(g: GossipSub)</a></li>
</ul>
<ul class="simple nested-toc-section">getGossipPeers
<li><a class="reference" href="#getGossipPeers%2CGossipSub"
title="getGossipPeers(g: GossipSub): Table[PubSubPeer, ControlMessage]">getGossipPeers(g: GossipSub): Table[PubSubPeer, ControlMessage]</a></li>
</ul>
<ul class="simple nested-toc-section">grafted
<li><a class="reference" href="#grafted%2CGossipSub%2CPubSubPeer%2Cstring"
title="grafted(g: GossipSub; p: PubSubPeer; topic: string)">grafted(g: GossipSub; p: PubSubPeer; topic: string)</a></li>
</ul>
<ul class="simple nested-toc-section">handleBackingOff
<li><a class="reference" href="#handleBackingOff%2CBackoffTable%2Cstring"
title="handleBackingOff(t: var BackoffTable; topic: string)">handleBackingOff(t: var BackoffTable; topic: string)</a></li>
</ul>
<ul class="simple nested-toc-section">handleGraft
<li><a class="reference" href="#handleGraft%2CGossipSub%2CPubSubPeer%2Cseq%5BControlGraft%5D"
title="handleGraft(g: GossipSub; peer: PubSubPeer; grafts: seq[ControlGraft]): seq[
ControlPrune]">handleGraft(g: GossipSub; peer: PubSubPeer; grafts: seq[ControlGraft]): seq[
ControlPrune]</a></li>
</ul>
<ul class="simple nested-toc-section">handleIDontWant
<li><a class="reference" href="#handleIDontWant%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIWant%5D"
title="handleIDontWant(g: GossipSub; peer: PubSubPeer; iDontWants: seq[ControlIWant])">handleIDontWant(g: GossipSub; peer: PubSubPeer; iDontWants: seq[ControlIWant])</a></li>
</ul>
<ul class="simple nested-toc-section">handleIHave
<li><a class="reference" href="#handleIHave%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIHave%5D"
title="handleIHave(g: GossipSub; peer: PubSubPeer; ihaves: seq[ControlIHave]): ControlIWant">handleIHave(g: GossipSub; peer: PubSubPeer; ihaves: seq[ControlIHave]): ControlIWant</a></li>
</ul>
<ul class="simple nested-toc-section">handleIWant
<li><a class="reference" href="#handleIWant%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIWant%5D"
title="handleIWant(g: GossipSub; peer: PubSubPeer; iwants: seq[ControlIWant]): seq[
Message]">handleIWant(g: GossipSub; peer: PubSubPeer; iwants: seq[ControlIWant]): seq[
Message]</a></li>
</ul>
<ul class="simple nested-toc-section">handlePrune
<li><a class="reference" href="#handlePrune%2CGossipSub%2CPubSubPeer%2Cseq%5BControlPrune%5D"
title="handlePrune(g: GossipSub; peer: PubSubPeer; prunes: seq[ControlPrune])">handlePrune(g: GossipSub; peer: PubSubPeer; prunes: seq[ControlPrune])</a></li>
</ul>
<ul class="simple nested-toc-section">heartbeat
<li><a class="reference" href="#heartbeat%2CGossipSub"
title="heartbeat(g: GossipSub): Future[void]">heartbeat(g: GossipSub): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">peerExchangeList
<li><a class="reference" href="#peerExchangeList%2CGossipSub%2Cstring"
title="peerExchangeList(g: GossipSub; topic: string): seq[PeerInfoMsg]">peerExchangeList(g: GossipSub; topic: string): seq[PeerInfoMsg]</a></li>
</ul>
<ul class="simple nested-toc-section">pruned
<li><a class="reference" href="#pruned%2CGossipSub%2CPubSubPeer%2Cstring%2Cbool"
title="pruned(g: GossipSub; p: PubSubPeer; topic: string; setBackoff: bool = true;
backoff = none(Duration))">pruned(g: GossipSub; p: PubSubPeer; topic: string; setBackoff: bool = true;
backoff = none(Duration))</a></li>
</ul>
<ul class="simple nested-toc-section">rebalanceMesh
<li><a class="reference" href="#rebalanceMesh%2CGossipSub%2Cstring%2Cptr.MeshMetrics"
title="rebalanceMesh(g: GossipSub; topic: string; metrics: ptr MeshMetrics = nil)">rebalanceMesh(g: GossipSub; topic: string; metrics: ptr MeshMetrics = nil)</a></li>
</ul>
<ul class="simple nested-toc-section">replenishFanout
<li><a class="reference" href="#replenishFanout%2CGossipSub%2Cstring"
title="replenishFanout(g: GossipSub; topic: string)">replenishFanout(g: GossipSub; topic: string)</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.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="types.html">types</a>, <a class="reference external" href="scoring.html">scoring</a>, <a class="reference external" href="../pubsubpeer.html">../pubsubpeer</a>, <a class="reference external" href="../peertable.html">../peertable</a>, <a class="reference external" href="../mcache.html">../mcache</a>, <a class="reference external" href="../floodsub.html">../floodsub</a>, <a class="reference external" href="../pubsub.html">../pubsub</a>, <a class="reference external" href="../rpc/messages.html">../rpc/messages</a>, <a class="reference external" href="../../../peerid.html">../../../peerid</a>, <a class="reference external" href="../../../multiaddress.html">../../../multiaddress</a>, <a class="reference external" href="../../../utility.html">../../../utility</a>, <a class="reference external" href="../../../switch.html">../../../switch</a>, <a class="reference external" href="../../../routing_record.html">../../../routing_record</a>, <a class="reference external" href="../../../signed_envelope.html">../../../signed_envelope</a>, <a class="reference external" href="../../../utils/heartbeat.html">../../../utils/heartbeat</a>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="dropFanoutPeers,GossipSub" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#dropFanoutPeers%2CGossipSub"><span class="Identifier">dropFanoutPeers</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L540"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L540" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="getGossipPeers,GossipSub" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#getGossipPeers%2CGossipSub"><span class="Identifier">getGossipPeers</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Table</span><span class="Other">[</span><a href="../pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a><span class="Other">,</span> <a href="../rpc/messages.html#ControlMessage"><span class="Identifier">ControlMessage</span></a><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
gossip iHave messages to peers
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L569"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L569" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="grafted,GossipSub,PubSubPeer,string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#grafted%2CGossipSub%2CPubSubPeer%2Cstring"><span class="Identifier">grafted</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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">topic</span><span class="Other">:</span> <span class="Identifier">string</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">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L33"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleBackingOff,BackoffTable,string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleBackingOff%2CBackoffTable%2Cstring"><span class="Identifier">handleBackingOff</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="types.html#BackoffTable"><span class="Identifier">BackoffTable</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L73"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleGraft,GossipSub,PubSubPeer,seq[ControlGraft]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleGraft%2CGossipSub%2CPubSubPeer%2Cseq%5BControlGraft%5D"><span class="Identifier">handleGraft</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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="Identifier">grafts</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#ControlGraft"><span class="Identifier">ControlGraft</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span>
<a href="../rpc/messages.html#ControlPrune"><span class="Identifier">ControlPrune</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L101"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L101" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleIDontWant,GossipSub,PubSubPeer,seq[ControlIWant]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleIDontWant%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIWant%5D"><span class="Identifier">handleIDontWant</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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="Identifier">iDontWants</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#ControlIWant"><span class="Identifier">ControlIWant</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L265"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L265" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleIHave,GossipSub,PubSubPeer,seq[ControlIHave]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleIHave%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIHave%5D"><span class="Identifier">handleIHave</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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="Identifier">ihaves</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#ControlIHave"><span class="Identifier">ControlIHave</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="../rpc/messages.html#ControlIWant"><span class="Identifier">ControlIWant</span></a> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L239"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L239" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleIWant,GossipSub,PubSubPeer,seq[ControlIWant]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleIWant%2CGossipSub%2CPubSubPeer%2Cseq%5BControlIWant%5D"><span class="Identifier">handleIWant</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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="Identifier">iwants</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#ControlIWant"><span class="Identifier">ControlIWant</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span>
<a href="../rpc/messages.html#Message"><span class="Identifier">Message</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L273"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L273" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handlePrune,GossipSub,PubSubPeer,seq[ControlPrune]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handlePrune%2CGossipSub%2CPubSubPeer%2Cseq%5BControlPrune%5D"><span class="Identifier">handlePrune</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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="Identifier">prunes</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#ControlPrune"><span class="Identifier">ControlPrune</span></a><span class="Other">]</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">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L207"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L207" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="heartbeat,GossipSub" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#heartbeat%2CGossipSub"><span class="Identifier">heartbeat</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L695"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L695" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="peerExchangeList,GossipSub,string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#peerExchangeList%2CGossipSub%2Cstring"><span class="Identifier">peerExchangeList</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../rpc/messages.html#PeerInfoMsg"><span class="Identifier">PeerInfoMsg</span></a><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L82"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L82" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="pruned,GossipSub,PubSubPeer,string,bool" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#pruned%2CGossipSub%2CPubSubPeer%2Cstring%2Cbool"><span class="Identifier">pruned</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</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">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">setBackoff</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
<span class="Identifier">backoff</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L45"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="rebalanceMesh,GossipSub,string,ptr.MeshMetrics" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#rebalanceMesh%2CGossipSub%2Cstring%2Cptr.MeshMetrics"><span class="Identifier">rebalanceMesh</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">metrics</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="types.html#MeshMetrics"><span class="Identifier">MeshMetrics</span></a> <span class="Other">=</span> <span class="Keyword">nil</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">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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L310"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L310" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="replenishFanout,GossipSub,string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#replenishFanout%2CGossipSub%2Cstring"><span class="Identifier">replenishFanout</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
get fanout peers for a topic
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/formatting/libp2p/protocols/pubsub/gossipsub/behavior.nim#L553"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub/behavior.nim#L553" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
update docs for formatting
2024-06-06 13:28:30 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2024-06-06 13:28:20 UTC</small>
update docs for formatting
2024-06-06 12:45:18 +00:00
</div>
</div>
</div>
</div>
</body>
</html>