2023-12-11 17:34:25 +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< / 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< / h1 >
< div class = "row" >
< div class = "three columns" >
< div class = "theme-switch-wrapper" >
< label class = "theme-switch" for = "checkbox" >
< input type = "checkbox" id = "checkbox" / >
< div class = "slider round" > < / div >
< / label >
< em > Dark Mode< / em >
< / div >
< div id = "global-links" >
< ul class = "simple" >
< li >
< a href = "../../theindex.html" > Index< / a >
< / li >
< / ul >
< / div >
< div id = "searchInputDiv" >
Search: < input type = "text" id = "searchInput"
onkeyup="search()" />
< / div >
< div >
Group by:
< select onchange = "groupBy(this.value)" >
< option value = "section" > Section< / option >
< option value = "type" > Type< / option >
< / select >
< / div >
< script type = "text/javascript" >
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
< div class = "theme-switch-wrapper" >
< label class = "theme-switch" for = "internalcheckbox" >
< input type = "checkbox" id = "internalcheckbox" >
< div class = "slider round" > < / div >
< / label >
< em > Internal< / em >
< / div >
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length ; i + + ) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length ; z + + ) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length ; y + + ) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length ; i + + ) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length ; i + + ) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length ; i + + ) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length ; i + + ) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
< / script >
< ul class = "simple simple-toc" id = "toc-list" >
< li >
< a class = "reference reference-toplevel" href = "#6" id = "56" > Imports< / a >
< ul class = "simple simple-toc-section" >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#19" id = "69" > Exports< / a >
< ul class = "simple simple-toc-section" >
< / ul >
< / li >
< / ul >
< / div >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/protocols/pubsub.nim#L1"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/pubsub.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > Home of PubSub & it's implementations:< p > < strong > pubsub< / strong > : base interface for pubsub implementations< br / > < strong > floodsub< / strong > : simple flood-based publishing< br / > < strong > gossipsub< / strong > : more sophisticated gossip based publishing< br / > < / p > < / 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/pubsub.html" > pubsub/pubsub< / a > , < a class = "reference external" href = "pubsub/floodsub.html" > pubsub/floodsub< / a > , < a class = "reference external" href = "pubsub/gossipsub.html" > pubsub/gossipsub< / a >
< / dl > < / div >
< div class = "section" id = "19" >
< h1 > < a class = "toc-backref" href = "#19" > Exports< / a > < / h1 >
< dl class = "item" >
< 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/pubsub.html#libp2p_pubsub_received_subscriptions" > < span class = "Identifier" > libp2p_pubsub_received_subscriptions< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_broadcast_unsubscriptions" > < span class = "Identifier" > libp2p_pubsub_broadcast_unsubscriptions< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_messages_rebroadcasted" > < span class = "Identifier" > libp2p_pubsub_messages_rebroadcasted< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_received_graft" > < span class = "Identifier" > libp2p_pubsub_received_graft< / span > < / a > , < a href = "pubsub/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/pubsub.html#send,PubSub,PubSubPeer,RPCMsg" > < span class = "Identifier" > send< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_received_prune" > < span class = "Identifier" > libp2p_pubsub_received_prune< / span > < / a > , < a href = "pubsub/pubsub.html#ValidatorHandler" > < span class = "Identifier" > ValidatorHandler< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_broadcast_iwant" > < span class = "Identifier" > libp2p_pubsub_broadcast_iwant< / span > < / a > , < a href = "pubsub/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/pubsub.html#unsubscribe,PubSub,string,TopicHandler" > < span class = "Identifier" > unsubscribe< / span > < / a > , < a href = "pubsub/pubsub.html#validate.e,PubSub,Message" > < span class = "Identifier" > validate< / span > < / a > , < a href = "pubsub/pubsub.html#removeObserver,PubSub,PubSubObserver" > < span class = "Identifier" > removeObserver< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_broadcast_graft" > < span class = "Identifier" > libp2p_pubsub_broadcast_graft< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_received_unsubscriptions" > < span class = "Identifier" > libp2p_pubsub_received_unsubscriptions< / span > < / a > , < a href = "pubsub/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/pubsub.html#MsgIdProvider" > < span class = "Identifier" > MsgIdProvider< / span > < / a > , < a href = "pubsub/pubsub.html#PubSub" > < span class = "Identifier" > PubSub< / span > < / a > , < a href = "pubsub/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/pubsub.html#onTopicSubscription.e,PubSub,string,bool" > < span class = "Identifier" > onTopicSubscription< / span > < / a > , < a href = "pubsub/pubsub.html#updateMetrics,PubSub,RPCMsg" > < span class = "Identifier" > updateMetrics< / span > < / a > , < a href = "pubsub/pubsub.html#libp2p_pubsub_broadcast_subscriptions" > < span class = "Identifier" > libp2p_pubsub_broadcast_subscriptions< / span > < / a > , < a href = "pubsub/pubsub.html#addValidator.e,PubSub,varargs[string],ValidatorHandler" > < span class = "Identifier" > addValidator< / span > < / a > , < a href = "pubsub/pubsub.html#KnownLibP2PTopics" > < span class = "Identifier" > KnownLibP2PTopics< / span > < / a > , < a href = "pubsub/pubsub.html#handleConn.e,PubSub,Connection,string" > < span class = "Identifier" > handleConn< / span > < / a > , < a href = "pubsub/pubsub.html#onPubSubPeerEvent.e,PubSub,PubSubPeer,PubSubPeerEvent" > < span class = "Identifier" > onPubSubPeerEvent< / span > < / a > , < a href = "pubsub/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 = "pubsub/errors.html#ValidationResult" > < span class = "Identifier" > ValidationResult< / span > < / a > , < a href = "pubsub/pubsub.html#broadcast,PubSub,auto,RPCMsg" > < span class = "Identifier" > broadcast< / span > <
< / dl > < / div >
< / div >
< / div >
< div class = "row" >
< div class = "twelve-columns footer" >
< span class = "nim-sprite" > < / span >
< br / >
2023-12-11 17:36:03 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2023-12-11 17:35:59 UTC< / small >
2023-12-11 17:34:25 +00:00
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
