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/handle-observed-add-in-rela.../libp2p/protocols/pubsub/gossipsub.html

580 lines
57 KiB
HTML
Raw Blame History

<?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</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</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">addDirectPeer
<li><a class="reference" href="#addDirectPeer%2CGossipSub%2CPeerId%2Cseq%5BMultiAddress%5D"
title="addDirectPeer(g: GossipSub; id: PeerId; addrs: seq[MultiAddress]): Future[void]">addDirectPeer(g: GossipSub; id: PeerId; addrs: seq[MultiAddress]): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">handleSubscribe
<li><a class="reference" href="#handleSubscribe%2CGossipSub%2CPubSubPeer%2Cstring%2Cbool"
title="handleSubscribe(g: GossipSub; peer: PubSubPeer; topic: string; subscribe: bool)">handleSubscribe(g: GossipSub; peer: PubSubPeer; topic: string; subscribe: bool)</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2Ctype%5BGossipSubParams%5D"
title="init(_: type[GossipSubParams]): GossipSubParams">init(_: type[GossipSubParams]): GossipSubParams</a></li>
</ul>
<ul class="simple nested-toc-section">rateLimit
<li><a class="reference" href="#rateLimit%2CGossipSub%2CPubSubPeer%2COpt%5BRPCMsg%5D%2Cint"
title="rateLimit(g: GossipSub; peer: PubSubPeer; rpcMsgOpt: Opt[RPCMsg]; msgSize: int): Future[
void]">rateLimit(g: GossipSub; peer: PubSubPeer; rpcMsgOpt: Opt[RPCMsg]; msgSize: int): Future[
void]</a></li>
</ul>
<ul class="simple nested-toc-section">validateParameters
<li><a class="reference" href="#validateParameters%2CGossipSubParams"
title="validateParameters(parameters: GossipSubParams): Result[void, cstring]">validateParameters(parameters: GossipSubParams): Result[void, cstring]</a></li>
<li><a class="reference" href="#validateParameters%2CTopicParams"
title="validateParameters(parameters: TopicParams): Result[void, cstring]">validateParameters(parameters: TopicParams): Result[void, cstring]</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">getOrCreatePeer
<li><a class="reference" href="#getOrCreatePeer.e%2CGossipSub%2CPeerId%2Cseq%5Bstring%5D"
title="getOrCreatePeer(g: GossipSub; peerId: PeerId; protos: seq[string]): PubSubPeer">getOrCreatePeer(g: GossipSub; peerId: PeerId; protos: seq[string]): PubSubPeer</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init.e%2CGossipSub"
title="init(g: GossipSub)">init(g: GossipSub)</a></li>
</ul>
<ul class="simple nested-toc-section">initPubSub
<li><a class="reference" href="#initPubSub.e%2CGossipSub"
title="initPubSub(g: GossipSub)">initPubSub(g: GossipSub)</a></li>
</ul>
<ul class="simple nested-toc-section">onNewPeer
<li><a class="reference" href="#onNewPeer.e%2CGossipSub%2CPubSubPeer"
title="onNewPeer(g: GossipSub; peer: PubSubPeer)">onNewPeer(g: GossipSub; peer: PubSubPeer)</a></li>
</ul>
<ul class="simple nested-toc-section">onPubSubPeerEvent
<li><a class="reference" href="#onPubSubPeerEvent.e%2CGossipSub%2CPubSubPeer%2CPubSubPeerEvent"
title="onPubSubPeerEvent(p: GossipSub; peer: PubSubPeer; event: PubSubPeerEvent)">onPubSubPeerEvent(p: GossipSub; peer: PubSubPeer; event: PubSubPeerEvent)</a></li>
</ul>
<ul class="simple nested-toc-section">onTopicSubscription
<li><a class="reference" href="#onTopicSubscription.e%2CGossipSub%2Cstring%2Cbool"
title="onTopicSubscription(g: GossipSub; topic: string; subscribed: bool)">onTopicSubscription(g: GossipSub; topic: string; subscribed: bool)</a></li>
</ul>
<ul class="simple nested-toc-section">publish
<li><a class="reference" href="#publish.e%2CGossipSub%2Cstring%2Cseq%5Bbyte%5D"
title="publish(g: GossipSub; topic: string; data: seq[byte]): Future[int]">publish(g: GossipSub; topic: string; data: seq[byte]): Future[int]</a></li>
</ul>
<ul class="simple nested-toc-section">rpcHandler
<li><a class="reference" href="#rpcHandler.e%2CGossipSub%2CPubSubPeer%2Cseq%5Bbyte%5D"
title="rpcHandler(g: GossipSub; peer: PubSubPeer; data: seq[byte]): Future[void]">rpcHandler(g: GossipSub; peer: PubSubPeer; data: seq[byte]): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">start
<li><a class="reference" href="#start.e%2CGossipSub"
title="start(g: GossipSub): Future[void]">start(g: GossipSub): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">stop
<li><a class="reference" href="#stop.e%2CGossipSub"
title="stop(g: GossipSub): Future[void]">stop(g: GossipSub): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">unsubscribePeer
<li><a class="reference" href="#unsubscribePeer.e%2CGossipSub%2CPeerId"
title="unsubscribePeer(g: GossipSub; peer: PeerId)">unsubscribePeer(g: GossipSub; peer: PeerId)</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.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.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">Gossip based publishing</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="pubsub.html">pubsub</a>, <a class="reference external" href="floodsub.html">floodsub</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="timedcache.html">timedcache</a>, <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="../protocol.html">../protocol</a>, <a class="reference external" href="../../stream/connection.html">../../stream/connection</a>, <a class="reference external" href="../../peerinfo.html">../../peerinfo</a>, <a class="reference external" href="../../peerid.html">../../peerid</a>, <a class="reference external" href="../../utility.html">../../utility</a>, <a class="reference external" href="../../switch.html">../../switch</a>, <a class="reference external" href="gossipsub/types.html">gossipsub/types</a>, <a class="reference external" href="gossipsub/scoring.html">gossipsub/scoring</a>, <a class="reference external" href="gossipsub/behavior.html">gossipsub/behavior</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="addDirectPeer,GossipSub,PeerId,seq[MultiAddress]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#addDirectPeer%2CGossipSub%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">addDirectPeer</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">id</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L676"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L676" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="handleSubscribe,GossipSub,PubSubPeer,string,bool" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#handleSubscribe%2CGossipSub%2CPubSubPeer%2Cstring%2Cbool"><span class="Identifier">handleSubscribe</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">topic</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
<span class="Identifier">subscribe</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L222"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L222" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,type[GossipSubParams]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctype%5BGossipSubParams%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">type</span><span class="Other">[</span><a href="gossipsub/types.html#GossipSubParams"><span class="Identifier">GossipSubParams</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="gossipsub/types.html#GossipSubParams"><span class="Identifier">GossipSubParams</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L49"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="rateLimit,GossipSub,PubSubPeer,Opt[RPCMsg],int" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#rateLimit%2CGossipSub%2CPubSubPeer%2COpt%5BRPCMsg%5D%2Cint"><span class="Identifier">rateLimit</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">rpcMsgOpt</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="rpc/messages.html#RPCMsg"><span class="Identifier">RPCMsg</span></a><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">msgSize</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="pubsubpeer.html#PeerRateLimitError"><span class="Identifier">PeerRateLimitError</span></a><span class="Other">,</span> <span class="Identifier">CatchableError</span><span class="Other">]</span><span class="Other">,</span> </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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L387"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L387" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="validateParameters,GossipSubParams" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#validateParameters%2CGossipSubParams"><span class="Identifier">validateParameters</span></a><span class="Other">(</span><span class="Identifier">parameters</span><span class="Other">:</span> <a href="gossipsub/types.html#GossipSubParams"><span class="Identifier">GossipSubParams</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">cstring</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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L86"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L86" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="validateParameters,TopicParams" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#validateParameters%2CTopicParams"><span class="Identifier">validateParameters</span></a><span class="Other">(</span><span class="Identifier">parameters</span><span class="Other">:</span> <a href="gossipsub/types.html#TopicParams"><span class="Identifier">TopicParams</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <span class="Identifier">cstring</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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L117"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L117" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="14">
<h1><a class="toc-backref" href="#14">Methods</a></h1>
<dl class="item">
<div id="getOrCreatePeer.e,GossipSub,PeerId,seq[string]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#getOrCreatePeer.e%2CGossipSub%2CPeerId%2Cseq%5Bstring%5D"><span class="Identifier">getOrCreatePeer</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/types.html#GossipSub"><span class="Identifier">GossipSub</span></a><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">protos</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</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="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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L727"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L727" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init.e,GossipSub" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CGossipSub"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L137"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L137" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="initPubSub.e,GossipSub" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#initPubSub.e%2CGossipSub"><span class="Identifier">initPubSub</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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><a href="pubsub.html#InitializationError"><span class="Identifier">InitializationError</span></a><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="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L710"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L710" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="onNewPeer.e,GossipSub,PubSubPeer" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#onNewPeer.e%2CGossipSub%2CPubSubPeer"><span class="Identifier">onNewPeer</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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><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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L156"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L156" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="onPubSubPeerEvent.e,GossipSub,PubSubPeer,PubSubPeerEvent" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#onPubSubPeerEvent.e%2CGossipSub%2CPubSubPeer%2CPubSubPeerEvent"><span class="Identifier">onPubSubPeerEvent</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="gossipsub/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">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 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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L170"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L170" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="onTopicSubscription.e,GossipSub,string,bool" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#onTopicSubscription.e%2CGossipSub%2Cstring%2Cbool"><span class="Identifier">onTopicSubscription</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">subscribed</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">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/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L526"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L526" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="publish.e,GossipSub,string,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#publish.e%2CGossipSub%2Cstring%2Cseq%5Bbyte%5D"><span class="Identifier">publish</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">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">int</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L559"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L559" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="rpcHandler.e,GossipSub,PubSubPeer,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#rpcHandler.e%2CGossipSub%2CPubSubPeer%2Cseq%5Bbyte%5D"><span class="Identifier">rpcHandler</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">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 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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L421"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L421" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="start.e,GossipSub" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#start.e%2CGossipSub"><span class="Identifier">start</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L685"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L685" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="stop.e,GossipSub" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#stop.e%2CGossipSub"><span class="Identifier">stop</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/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">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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L697"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L697" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="unsubscribePeer.e,GossipSub,PeerId" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#unsubscribePeer.e%2CGossipSub%2CPeerId"><span class="Identifier">unsubscribePeer</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <a href="gossipsub/types.html#GossipSub"><span class="Identifier">GossipSub</span></a><span class="Other">;</span> <span class="Identifier">peer</span><span class="Other">:</span> <a href="../../peerid.html#PeerId"><span class="Identifier">PeerId</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>.}</pre></dt>
<dd>
handle peer disconnects
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/handle-observed-add-in-relay-conns/libp2p/protocols/pubsub/gossipsub.nim#L186"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub/gossipsub.nim#L186" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="gossipsub/types.html#GossipSubD"><span class="Identifier">GossipSubD</span></a>, <a href="gossipsub/types.html#IHaveMaxLength"><span class="Identifier">IHaveMaxLength</span></a>, <a href="gossipsub/types.html#BackoffSlackTime"><span class="Identifier">BackoffSlackTime</span></a>, <a href="gossipsub/types.html#GossipSubHistoryLength"><span class="Identifier">GossipSubHistoryLength</span></a>, <a href="gossipsub/types.html#GossipBackoffPeriod"><span class="Identifier">GossipBackoffPeriod</span></a>, <a href="gossipsub/types.html#PeerStats"><span class="Identifier">PeerStats</span></a>, <a href="gossipsub/types.html#IHavePeerBudget"><span class="Identifier">IHavePeerBudget</span></a>, <a href="gossipsub/types.html#GossipSubCodec"><span class="Identifier">GossipSubCodec</span></a>, <a href="gossipsub/types.html#GossipSub"><span class="Identifier">GossipSub</span></a>, <a href="gossipsub/types.html#GossipSubParams"><span class="Identifier">GossipSubParams</span></a>, <a href="gossipsub/types.html#GossipSubFanoutTTL"><span class="Identifier">GossipSubFanoutTTL</span></a>, <a href="gossipsub/types.html#GossipSubCodec_10"><span class="Identifier">GossipSubCodec_10</span></a>, <a href="gossipsub/types.html#GossipSubDlo"><span class="Identifier">GossipSubDlo</span></a>, <a href="gossipsub/types.html#RoutingRecordsHandler"><span class="Identifier">RoutingRecordsHandler</span></a>, <a href="gossipsub/types.html#GossipSubHistoryGossip"><span class="Identifier">GossipSubHistoryGossip</span></a>, <a href="gossipsub/types.html#GossipSubHeartbeatInterval"><span class="Identifier">GossipSubHeartbeatInterval</span></a>, <a href="gossipsub/types.html#MeshMetrics"><span class="Identifier">MeshMetrics</span></a>, <a href="gossipsub/types.html#BackoffTable"><span class="Identifier">BackoffTable</span></a>, <a href="gossipsub/types.html#RoutingRecordsPair"><span class="Identifier">RoutingRecordsPair</span></a>, <a href="gossipsub/types.html#TopicInfo"><span class="Identifier">TopicInfo</span></a>, <a href="gossipsub/types.html#ValidationSeenTable"><span class="Identifier">ValidationSeenTable</span></a>, <a href="gossipsub/types.html#GossipSubDhi"><span class="Identifier">GossipSubDhi</span></a>, <a href="gossipsub/types.html#PingsPeerBudget"><span class="Identifier">PingsPeerBudget</span></a>, <a href="gossipsub/types.html#TopicParams"><span class="Identifier">TopicParams</span></a>, <a href="gossipsub/scoring.html#updateScores,GossipSub"><span class="Identifier">updateScores</span></a>, <a href="gossipsub/scoring.html#libp2p_gossipsub_peers_rate_limit_hits"><span class="Identifier">libp2p_gossipsub_peers_rate_limit_hits</span></a>, <a href="gossipsub/scoring.html#disconnectPeer,GossipSub,PubSubPeer"><span class="Identifier">disconnectPeer</span></a>, <a href="gossipsub/scoring.html#init,type[TopicParams]"><span class="Identifier">init</span></a>, <a href="gossipsub/scoring.html#disconnectIfBadScorePeer,GossipSub,PubSubPeer,float64"><span class="Identifier">disconnectIfBadScorePeer</span></a>, <a href="gossipsub/scoring.html#withPeerStats,GossipSub,PeerId,proc(PeerStats)"><span class="Identifier">withPeerStats</span></a>, <a href="gossipsub/scoring.html#byScore,PubSubPeer,PubSubPeer"><span class="Identifier">byScore</span></a>, <a href="gossipsub/scoring.html#punishInvalidMessage,GossipSub,PubSubPeer,Message"><span class="Identifier">punishInvalidMessage</span></a>, <a href="gossipsub/scoring.html#rewardDelivered,GossipSub,PubSubPeer,openArray[string],bool"><span class="Identifier">rewardDelivered</span></a>, <a href="gossipsub/scoring.html#scoringHeartbeat,GossipSub"><span class="Identifier">scoringHeartbeat</span></a>, <a href="gossipsub/scoring.html#addCapped,T,T,T"><span class="Identifier">addCapped</span></a>, <a href="gossipsub/behavior.html#getGossipPeers,GossipSub"><span class="Identifier">getGossipPeers</span></a>, <a href="gossipsub/behavior.html#handleIDontWant,GossipSub,PubSubPeer,seq[ControlIWant]"><span class="Identifier">handleIDontWant</span></a>, <a href="gossipsub/behavior.html#replenishFanout,GossipSub,string"><span class="Identifier">replenishFanout</span></a>, <a href="gossipsub/behavior.html#rebalanceMesh,GossipSub,string,ptr.MeshMetrics"><span class="Identifier">rebalanceMesh</span></a>, <a href="gossipsub/behavior.html#dropFanoutPeers,GossipSub"><span class="Identifier">dropFanoutPeers</span></a>, <a href="gossipsub/behavior.html#handleIWant,GossipSub,PubSubPeer,seq[ControlIWant]"><span class="Identifier">handleIWant</span></a>, <a href="gossipsub/behavior.html#pruned,GossipSub,PubSubPeer,string,bool"><span class="Identifier">pruned</span></a>, <a href="gossipsub/behavior.html#handleBackingOff,BackoffTable,string"><span class="Identifier">handleBackingOff</span></a>, <a href="gossipsub/behavior.html#peerExchangeList,GossipSub,string"><span class="Identifier">peerExchangeList</span></a>, <a href="gossipsub/behavior.html#handleGraft,GossipSub,PubSubPeer,seq[ControlGraft]"><span class="Identifier">handleGraft</span></a>, <a href="gossipsub/behavior.html#grafted,GossipSub,PubSubPeer,string"><span class="Identifier">grafted</span></a>, <a href="gossipsub/behavior.html#handleIHave,GossipSub,PubSubPeer,seq[ControlIHave]"><span class="Identifier">handleIHave</span></a>, <a href="gossipsub/behavior.html#handlePrune,GossipSub,PubSubPeer,seq[ControlPrune]"><span class="Identifier">handlePrune</span></a>, <a href="gossipsub/behavior.html#heartbeat,GossipSub"><span class="Identifier">heartbeat</span></a>, <a href="../protocol.html#maxIncomingStreams=,LPProtocol,int"><span class="Identifier">maxIncomingStreams=</span></a>, <a href="../protocol.html#codec=,LPProtocol,string"><span class="Identifier">codec=</span></a>, <a href="pubsub.html#libp2p_pubsub_received_subscriptions"><span class="Identifier">libp2p_pubsub_received_subscriptions</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_unsubscriptions"><span class="Identifier">libp2p_pubsub_broadcast_unsubscriptions</span></a>, <a href="pubsub.html#libp2p_pubsub_messages_rebroadcasted"><span class="Identifier">libp2p_pubsub_messages_rebroadcasted</span></a>, <a href="pubsub.html#libp2p_pubsub_received_graft"><span class="Identifier">libp2p_pubsub_received_graft</span></a>, <a href="pubsub.html#removeValidator.e,PubSub,varargs[string],ValidatorHandler"><span class="Identifier">removeValidator</span></a>, <a href="../protocol.html#DefaultMaxIncomingStreams"><span class="Identifier">DefaultMaxIncomingStreams</span></a>, <a href="pubsub.html#send,PubSub,PubSubPeer,RPCMsg"><span class="Identifier">send</span></a>, <a href="pubsub.html#libp2p_pubsub_received_prune"><span class="Identifier">libp2p_pubsub_received_prune</span></a>, <a href="pubsub.html#ValidatorHandler"><span class="Identifier">ValidatorHandler</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_iwant"><span class="Identifier">libp2p_pubsub_broadcast_iwant</span></a>, <a href="pubsub.html#init,typedesc[PubSub],Switch,bool,bool,bool,bool,MsgIdProvider,SubscriptionValidator,int,ref.HmacDrbgContext,PubParams"><span class="Identifier">init</span></a>, <a href="pubsub.html#unsubscribe,PubSub,string,TopicHandler"><span class="Identifier">unsubscribe</span></a>, <a href="pubsub.html#validate.e,PubSub,Message"><span class="Identifier">validate</span></a>, <a href="pubsub.html#removeObserver,PubSub,PubSubObserver"><span class="Identifier">removeObserver</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_graft"><span class="Identifier">libp2p_pubsub_broadcast_graft</span></a>, <a href="pubsub.html#libp2p_pubsub_received_unsubscriptions"><span class="Identifier">libp2p_pubsub_received_unsubscriptions</span></a>, <a href="pubsub.html#sendSubs,PubSub,PubSubPeer,openArray[string],bool"><span class="Identifier">sendSubs</span></a>, <a href="../protocol.html#codec,LPProtocol"><span class="Identifier">codec</span></a>, <a href="pubsub.html#MsgIdProvider"><span class="Identifier">MsgIdProvider</span></a>, <a href="pubsub.html#PubSub"><span class="Identifier">PubSub</span></a>, <a href="pubsub.html#SubscriptionValidator"><span class="Identifier">SubscriptionValidator</span></a>, <a href="../protocol.html#start.e,LPProtocol"><span class="Identifier">start</span></a>, <a href="pubsub.html#onTopicSubscription.e,PubSub,string,bool"><span class="Identifier">onTopicSubscription</span></a>, <a href="pubsub.html#updateMetrics,PubSub,RPCMsg"><span class="Identifier">updateMetrics</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_subscriptions"><span class="Identifier">libp2p_pubsub_broadcast_subscriptions</span></a>, <a href="pubsub.html#addValidator.e,PubSub,varargs[string],ValidatorHandler"><span class="Identifier">addValidator</span></a>, <a href="pubsub.html#KnownLibP2PTopics"><span class="Identifier">KnownLibP2PTopics</span></a>, <a href="pubsub.html#handleConn.e,PubSub,Connection,string"><span class="Identifier">handleConn</span></a>, <a href="pubsub.html#onPubSubPeerEvent.e,PubSub,PubSubPeer,PubSubPeerEvent"><span class="Identifier">onPubSubPeerEvent</span></a>, <a href="pubsub.html#publish.e,PubSub,string,seq[byte]"><span class="Identifier">publish</span></a>, <a href="../protocol.html#LPProtocol"><span class="Identifier">LPProtocol</span></a>, <a href="errors.html#ValidationResult"><span class="Identifier">ValidationResult</span></a>, <a href="pubsub.html#broadcast,PubSub,auto,RPCMsg"><span class="Identifier">broadcast</span></a>, <a href="pubsub.html#subscribe,PubSub,string,TopicHandler"><span class="Identifier">subscribe</span></a>, <a href="pubsub.html#addObserver,PubSub,PubSubObserver"><span class="Identifier">addObserver</span></a>, <a href="pubsubpeer.html#PubSubObserver"><span class="Identifier">PubSubObserver</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_prune"><span class="Identifier">libp2p_pubsub_broadcast_prune</span></a>, <a href="pubsubpeer.html#PubSubPeer"><span class="Identifier">PubSubPeer</span></a>, <a href="pubsub.html#unsubscribePeer.e,PubSub,PeerId"><span class="Identifier">unsubscribePeer</span></a>, <a href="pubsub.html#rpcHandler.e,PubSub,PubSubPeer,seq[byte]"><span class="Identifier">rpcHandler</span></a>, <a href="../protocol.html#init.e,LPProtocol"><span class="Identifier">init</span></a>, <a href="pubsub.html#KnownLibP2PTopicsSeq"><span class="Identifier">KnownLibP2PTopicsSeq</span></a>, <a href="pubsub.html#handleData,PubSub,string,seq[byte]"><span class="Identifier">handleData</span></a>, <a href="../protocol.html#LPProtoHandler"><span class="Identifier">LPProtoHandler</span></a>, <a href="pubsub.html#libp2p_pubsub_received_ihave"><span class="Identifier">libp2p_pubsub_received_ihave</span></a>, <a href="../protocol.html#new,typeLPProtocol,seq[string],LPProtoHandler"><span class="Identifier">new</span></a>, <a href="pubsub.html#TopicPair"><span class="Identifier">TopicPair</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_ihave"><span class="Identifier">libp2p_pubsub_broadcast_ihave</span></a>, <a href="pubsub.html#subscribePeer.e,PubSub,PeerId"><span class="Identifier">subscribePeer</span></a>, <a href="pubsub.html#libp2p_pubsub_received_iwant"><span class="Identifier">libp2p_pubsub_received_iwant</span></a>, <a href="../protocol.html#maxIncomingStreams,LPProtocol"><span class="Identifier">maxIncomingStreams</span></a>, <a href="pubsub.html#libp2p_pubsub_broadcast_messages"><span class="Identifier">libp2p_pubsub_broadcast_messages</span></a>, <a href="pubsub.html#initPubSub.e,PubSub"><span class="Identifier">initPubSub</span></a>, <a href="pubsub.html#libp2p_pubsub_messages_published"><span class="Identifier">libp2p_pubsub_messages_published</span></a>, <a href="pubsub.html#TopicHandler"><span class="Identifier">TopicHandler</span></a>, <a href="pubsub.html#unsubscribeAll,PubSub,string"><span class="Identifier">unsubscribeAll</span></a>, <a href="pubsub.html#InitializationError"><span class="Identifier">InitializationError</span></a>, <a href="pubsub.html#libp2p_pubsub_received_messages"><span class="Identifier">libp2p_pubsub_received_messages</span></a>, <a href="pubsub.html#unsubscribe,PubSub,openArray[TopicPair]"><span class="Identifier">unsubscribe</span></a>, <a href="pubsub.html#getOrCreatePeer.e,PubSub,PeerId,seq[string]"><span class="Identifier">getOrCreatePeer</span></a>, <a href="../protocol.html#stop.e,LPProtocol"><span class="Identifier">stop</span></a>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2023-11-21 15:26:20 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink