2023-12-18 18:06:09 +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/switch< / 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/switch< / h1 >
< div class = "row" >
< div class = "three columns" >
< div class = "theme-switch-wrapper" >
< label class = "theme-switch" for = "checkbox" >
< input type = "checkbox" id = "checkbox" / >
< div class = "slider round" > < / div >
< / label >
< em > Dark Mode< / em >
< / div >
< div id = "global-links" >
< ul class = "simple" >
< li >
< a href = "../theindex.html" > Index< / a >
< / li >
< / ul >
< / div >
< div id = "searchInputDiv" >
Search: < input type = "text" id = "searchInput"
onkeyup="search()" />
< / div >
< div >
Group by:
< select onchange = "groupBy(this.value)" >
< option value = "section" > Section< / option >
< option value = "type" > Type< / option >
< / select >
< / div >
< script type = "text/javascript" >
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
< div class = "theme-switch-wrapper" >
< label class = "theme-switch" for = "internalcheckbox" >
< input type = "checkbox" id = "internalcheckbox" >
< div class = "slider round" > < / div >
< / label >
< em > Internal< / em >
< / div >
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length ; i + + ) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length ; z + + ) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length ; y + + ) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length ; i + + ) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length ; i + + ) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length ; i + + ) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length ; i + + ) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
< / script >
< ul class = "simple simple-toc" id = "toc-list" >
< li >
< a class = "reference reference-toplevel" href = "#6" id = "56" > Imports< / a >
< ul class = "simple simple-toc-section" >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#7" id = "57" > Types< / a >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#Service"
title="Service = ref object of RootObj
inUse: bool">Service< / a > < / li >
< li > < a class = "reference" href = "#Switch"
title="Switch {.public.} = ref object of Dial
peerInfo*: PeerInfo
connManager*: ConnManager
transports*: seq[Transport]
ms*: MultistreamSelect
acceptFuts: seq[Future[void]]
dialer*: Dial
peerStore*: PeerStore
nameResolver*: NameResolver
started: bool
services*: seq[Service]">Switch< / a > < / li >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#10" id = "60" > Consts< / a >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#ConcurrentUpgrades"
title="ConcurrentUpgrades = 4">ConcurrentUpgrades< / a > < / li >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#12" id = "62" > Procs< / a >
< ul class = "simple simple-toc-section" >
< ul class = "simple nested-toc-section" > addConnEventHandler
< li > < a class = "reference" href = "#addConnEventHandler%2CSwitch%2CConnEventHandler%2CConnEventKind"
title="addConnEventHandler(s: Switch; handler: ConnEventHandler; kind: ConnEventKind)">addConnEventHandler(s: Switch; handler: ConnEventHandler; kind: ConnEventKind)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > addPeerEventHandler
< li > < a class = "reference" href = "#addPeerEventHandler%2CSwitch%2CPeerEventHandler%2CPeerEventKind"
title="addPeerEventHandler(s: Switch; handler: PeerEventHandler; kind: PeerEventKind)">addPeerEventHandler(s: Switch; handler: PeerEventHandler; kind: PeerEventKind)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > connectedPeers
< li > < a class = "reference" href = "#connectedPeers%2CSwitch%2CDirection"
title="connectedPeers(s: Switch; dir: Direction): seq[PeerId]">connectedPeers(s: Switch; dir: Direction): seq[PeerId]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > dial
< li > < a class = "reference" href = "#dial%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D%2Cstring"
title="dial(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; proto: string): Future[
Connection]">dial(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; proto: string): Future[
Connection]< / a > < / li >
< li > < a class = "reference" href = "#dial%2CSwitch%2CPeerId%2Cstring"
title="dial(s: Switch; peerId: PeerId; proto: string): Future[Connection]">dial(s: Switch; peerId: PeerId; proto: string): Future[Connection]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > disconnect
< li > < a class = "reference" href = "#disconnect%2CSwitch%2CPeerId"
title="disconnect(s: Switch; peerId: PeerId): Future[void]">disconnect(s: Switch; peerId: PeerId): Future[void]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > isConnected
< li > < a class = "reference" href = "#isConnected%2CSwitch%2CPeerId"
title="isConnected(s: Switch; peerId: PeerId): bool">isConnected(s: Switch; peerId: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > mount
< li > < a class = "reference" href = "#mount%2CSwitch%2CT%2CMatcher"
title="mount[T: LPProtocol](s: Switch; proto: T; matcher: Matcher = nil)">mount[T: LPProtocol](s: Switch; proto: T; matcher: Matcher = nil)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newSwitch
< li > < a class = "reference" href = "#newSwitch%2CPeerInfo%2Cseq%5BTransport%5D%2CopenArray%5BSecure%5D%2CConnManager%2CMultistreamSelect%2CPeerStore%2CNameResolver"
title="newSwitch(peerInfo: PeerInfo; transports: seq[Transport];
secureManagers: openArray[Secure] = []; connManager: ConnManager;
ms: MultistreamSelect; peerStore: PeerStore;
nameResolver: NameResolver = nil; services = newSeq()): Switch">newSwitch(peerInfo: PeerInfo; transports: seq[Transport];
secureManagers: openArray[Secure] = []; connManager: ConnManager;
ms: MultistreamSelect; peerStore: PeerStore;
nameResolver: NameResolver = nil; services = newSeq()): Switch< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > removeConnEventHandler
< li > < a class = "reference" href = "#removeConnEventHandler%2CSwitch%2CConnEventHandler%2CConnEventKind"
title="removeConnEventHandler(s: Switch; handler: ConnEventHandler; kind: ConnEventKind)">removeConnEventHandler(s: Switch; handler: ConnEventHandler; kind: ConnEventKind)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > removePeerEventHandler
< li > < a class = "reference" href = "#removePeerEventHandler%2CSwitch%2CPeerEventHandler%2CPeerEventKind"
title="removePeerEventHandler(s: Switch; handler: PeerEventHandler; kind: PeerEventKind)">removePeerEventHandler(s: Switch; handler: PeerEventHandler; kind: PeerEventKind)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > start
< li > < a class = "reference" href = "#start%2CSwitch"
title="start(s: Switch): Future[void]">start(s: Switch): Future[void]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > stop
< li > < a class = "reference" href = "#stop%2CSwitch"
title="stop(s: Switch): Future[void]">stop(s: Switch): Future[void]< / 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" > addTransport
< li > < a class = "reference" href = "#addTransport.e%2CSwitch%2CTransport"
title="addTransport(s: Switch; t: Transport)">addTransport(s: Switch; t: Transport)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > connect
< li > < a class = "reference" href = "#connect.e%2CSwitch%2CMultiAddress"
title="connect(s: Switch; address: MultiAddress; allowUnknownPeerId = false): Future[
PeerId]">connect(s: Switch; address: MultiAddress; allowUnknownPeerId = false): Future[
PeerId]< / a > < / li >
< li > < a class = "reference" href = "#connect.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D"
title="connect(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
2024-04-29 13:39:28 +00:00
reuseConnection = true; dir = Direction.Out): Future[void]">connect(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; forceDial = false;
reuseConnection = true; dir = Direction.Out): Future[void]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > dial
< li > < a class = "reference" href = "#dial.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D%2Cseq%5Bstring%5D"
title="dial(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; protos: seq[string];
forceDial = false): Future[Connection]">dial(s: Switch; peerId: PeerId; addrs: seq[MultiAddress]; protos: seq[string];
forceDial = false): Future[Connection]< / a > < / li >
< li > < a class = "reference" href = "#dial.e%2CSwitch%2CPeerId%2Cseq%5Bstring%5D"
title="dial(s: Switch; peerId: PeerId; protos: seq[string]): Future[Connection]">dial(s: Switch; peerId: PeerId; protos: seq[string]): Future[Connection]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > run
< li > < a class = "reference" href = "#run.e%2CService%2CSwitch"
title="run(self: Service; switch: Switch): Future[void]">run(self: Service; switch: Switch): Future[void]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > setup
< li > < a class = "reference" href = "#setup.e%2CService%2CSwitch"
title="setup(self: Service; switch: Switch): Future[bool]">setup(self: Service; switch: Switch): Future[bool]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > stop
< li > < a class = "reference" href = "#stop.e%2CService%2CSwitch"
title="stop(self: Service; switch: Switch): Future[bool]">stop(self: Service; switch: Switch): Future[bool]< / a > < / li >
< / ul >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#19" id = "69" > Exports< / a >
< ul class = "simple simple-toc-section" >
< / ul >
< / li >
< / ul >
< / div >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L1"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > The switch is the core of libp2p, which brings together the transports, the connection manager, the upgrader and other parts to allow programs to use libp2p< / p >
< div class = "section" id = "6" >
< h1 > < a class = "toc-backref" href = "#6" > Imports< / a > < / h1 >
< dl class = "item" >
< a class = "reference external" href = "stream/connection.html" > stream/connection< / a > , < a class = "reference external" href = "transports/transport.html" > transports/transport< / a > , < a class = "reference external" href = "upgrademngrs/upgrade.html" > upgrademngrs/upgrade< / a > , < a class = "reference external" href = "multistream.html" > multistream< / a > , < a class = "reference external" href = "multiaddress.html" > multiaddress< / a > , < a class = "reference external" href = "protocols/protocol.html" > protocols/protocol< / a > , < a class = "reference external" href = "protocols/secure/secure.html" > protocols/secure/secure< / a > , < a class = "reference external" href = "peerinfo.html" > peerinfo< / a > , < a class = "reference external" href = "utils/semaphore.html" > utils/semaphore< / a > , < a class = "reference external" href = "connmanager.html" > connmanager< / a > , < a class = "reference external" href = "nameresolving/nameresolver.html" > nameresolving/nameresolver< / a > , < a class = "reference external" href = "peerid.html" > peerid< / a > , < a class = "reference external" href = "peerstore.html" > peerstore< / a > , < a class = "reference external" href = "errors.html" > errors< / a > , < a class = "reference external" href = "utility.html" > utility< / a > , < a class = "reference external" href = "dialer.html" > dialer< / a >
< / dl > < / div >
< div class = "section" id = "7" >
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "Service" class = "tohide" >
< dt > < pre > < a href = "transports/transport.html#Service" > < span class = "Identifier" > Service< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > ref< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < span class = "Identifier" > RootObj< / span >
< span class = "Identifier" > inUse< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span >
< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L64"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L64" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "Switch" class = "tohide" >
< dt > < pre > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > {.< span class = "Identifier" > public< / span > .} < span class = "Other" > =< / span > < span class = "Keyword" > ref< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "dial.html#Dial" > < span class = "Identifier" > Dial< / span > < / a >
< span class = "Identifier" > peerInfo< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a >
< span class = "Identifier" > connManager< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnManager" > < span class = "Identifier" > ConnManager< / span > < / a >
< span class = "Identifier" > transports< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < a href = "upgrademngrs/upgrade.html#Transport" > < span class = "Identifier" > Transport< / span > < / a > < span class = "Other" > ]< / span >
< span class = "Identifier" > ms< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "multistream.html#MultistreamSelect" > < span class = "Identifier" > MultistreamSelect< / span > < / a >
< span class = "Identifier" > acceptFuts< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ]< / span > < span class = "Other" > ]< / span >
< span class = "Identifier" > dialer< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "dial.html#Dial" > < span class = "Identifier" > Dial< / span > < / a >
< span class = "Identifier" > peerStore< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerStore" > < span class = "Identifier" > PeerStore< / span > < / a >
< span class = "Identifier" > nameResolver< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "nameresolving/nameresolver.html#NameResolver" > < span class = "Identifier" > NameResolver< / span > < / a >
< span class = "Identifier" > started< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span >
< span class = "Identifier" > services< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < a href = "transports/transport.html#Service" > < span class = "Identifier" > Service< / span > < / a > < span class = "Other" > ]< / span >
< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L52"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L52" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "10" >
< h1 > < a class = "toc-backref" href = "#10" > Consts< / a > < / h1 >
< dl class = "item" >
< div id = "ConcurrentUpgrades" class = "tohide" >
< dt > < pre > < a href = "transports/transport.html#ConcurrentUpgrades" > < span class = "Identifier" > ConcurrentUpgrades< / span > < / a > < span class = "Other" > =< / span > < span class = "DecNumber" > 4< / span > < / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L49"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L49" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "12" >
< h1 > < a class = "toc-backref" href = "#12" > Procs< / a > < / h1 >
< dl class = "item" >
< div id = "addConnEventHandler,Switch,ConnEventHandler,ConnEventKind" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#addConnEventHandler%2CSwitch%2CConnEventHandler%2CConnEventKind" > < span class = "Identifier" > addConnEventHandler< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > handler< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnEventHandler" > < span class = "Identifier" > ConnEventHandler< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > kind< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnEventKind" > < span class = "Identifier" > ConnEventKind< / span > < / a > < span class = "Other" > )< / span > {.< span class = "Identifier" > public< / 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 >
< p > Adds a ConnEventHandler, which will be triggered when a connection to a peer is created or dropped. There may be multiple connections per peer.< / p >
< p > The handler should not raise.< / p >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L84"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L84" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "addPeerEventHandler,Switch,PeerEventHandler,PeerEventKind" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#addPeerEventHandler%2CSwitch%2CPeerEventHandler%2CPeerEventKind" > < span class = "Identifier" > addPeerEventHandler< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > handler< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerEventHandler" > < span class = "Identifier" > PeerEventHandler< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > kind< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerEventKind" > < span class = "Identifier" > PeerEventKind< / span > < / a > < span class = "Other" > )< / span > {.< span class = "Identifier" > public< / 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 >
< p > Adds a PeerEventHandler, which will be triggered when a peer connects or disconnects from us.< / p >
< p > The handler should not raise.< / p >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L99"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L99" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "connectedPeers,Switch,Direction" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#connectedPeers%2CSwitch%2CDirection" > < span class = "Identifier" > connectedPeers< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > dir< / span > < span class = "Other" > :< / span > < a href = "stream/lpstream.html#Direction" > < span class = "Identifier" > Direction< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / 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" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L117"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L117" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "dial,Switch,PeerId,seq[MultiAddress],string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#dial%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D%2Cstring" > < span class = "Identifier" > dial< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > 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 = "Identifier" > proto< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span >
< a href = "stream/connection.html#Connection" > < span class = "Identifier" > Connection< / span > < / a > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / 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 >
Connected to a peer and open a stream with the specified < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > proto< / span > < / span > < / tt >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L178"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L178" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "dial,Switch,PeerId,string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#dial%2CSwitch%2CPeerId%2Cstring" > < span class = "Identifier" > dial< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > proto< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < a href = "stream/connection.html#Connection" > < span class = "Identifier" > Connection< / span > < / a > < span class = "Other" > ]< / span > {.
< span class = "Identifier" > public< / 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 >
Open a stream to a connected peer with the specified < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > proto< / span > < / span > < / tt >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L161"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L161" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "disconnect,Switch,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#disconnect%2CSwitch%2CPeerId" > < span class = "Identifier" > disconnect< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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 = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ]< / span > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > gcsafe< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / 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 >
Disconnect from a peer, waiting for the connection(s) to be dropped
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L127"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L127" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "isConnected,Switch,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#isConnected%2CSwitch%2CPeerId" > < span class = "Identifier" > isConnected< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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 = "Other" > :< / span > < span class = "Identifier" > bool< / span > {.< span class = "Identifier" > public< / 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 >
returns true if the peer has one or more associated connections
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L120"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L120" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "mount,Switch,T,Matcher" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#mount%2CSwitch%2CT%2CMatcher" > < span class = "Identifier" > mount< / span > < / a > < span class = "Other" > [< / span > < span class = "Identifier" > T< / span > < span class = "Other" > :< / span > < a href = "protocols/protocol.html#LPProtocol" > < span class = "Identifier" > LPProtocol< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > proto< / span > < span class = "Other" > :< / span > < span class = "Identifier" > T< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > matcher< / span > < span class = "Other" > :< / span > < a href = "multistream.html#Matcher" > < span class = "Identifier" > Matcher< / 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" > gcsafe< / span > < span class = "Other" > ,< / span >
< span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < a href = "errors.html#LPError" > < span class = "Identifier" > LPError< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / 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 > .}< / pre > < / dt >
< dd >
mount a protocol to the switch
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L186"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L186" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newSwitch,PeerInfo,seq[Transport],openArray[Secure],ConnManager,MultistreamSelect,PeerStore,NameResolver" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newSwitch%2CPeerInfo%2Cseq%5BTransport%5D%2CopenArray%5BSecure%5D%2CConnManager%2CMultistreamSelect%2CPeerStore%2CNameResolver" > < span class = "Identifier" > newSwitch< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > peerInfo< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > transports< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < a href = "upgrademngrs/upgrade.html#Transport" > < span class = "Identifier" > Transport< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span >
< span class = "Identifier" > secureManagers< / span > < span class = "Other" > :< / span > < span class = "Identifier" > openArray< / span > < span class = "Other" > [< / span > < a href = "protocols/secure/secure.html#Secure" > < span class = "Identifier" > Secure< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > =< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > connManager< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnManager" > < span class = "Identifier" > ConnManager< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > ms< / span > < span class = "Other" > :< / span > < a href = "multistream.html#MultistreamSelect" > < span class = "Identifier" > MultistreamSelect< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > peerStore< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerStore" > < span class = "Identifier" > PeerStore< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > nameResolver< / span > < span class = "Other" > :< / span > < a href = "nameresolving/nameresolver.html#NameResolver" > < span class = "Identifier" > NameResolver< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > nil< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > services< / span > < span class = "Other" > =< / span > < span class = "Identifier" > newSeq< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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 > < a href = "errors.html#LPError" > < span class = "Identifier" > LPError< / 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 >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L343"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L343" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "removeConnEventHandler,Switch,ConnEventHandler,ConnEventKind" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#removeConnEventHandler%2CSwitch%2CConnEventHandler%2CConnEventKind" > < span class = "Identifier" > removeConnEventHandler< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > handler< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnEventHandler" > < span class = "Identifier" > ConnEventHandler< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > kind< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#ConnEventKind" > < span class = "Identifier" > ConnEventKind< / span > < / a > < span class = "Other" > )< / span > {.< span class = "Identifier" > public< / 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 >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L94"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L94" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "removePeerEventHandler,Switch,PeerEventHandler,PeerEventKind" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#removePeerEventHandler%2CSwitch%2CPeerEventHandler%2CPeerEventKind" > < span class = "Identifier" > removePeerEventHandler< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > handler< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerEventHandler" > < span class = "Identifier" > PeerEventHandler< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > kind< / span > < span class = "Other" > :< / span > < a href = "peerstore.html#PeerEventKind" > < span class = "Identifier" > PeerEventKind< / span > < / a > < span class = "Other" > )< / span > {.< span class = "Identifier" > public< / 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 >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L108"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L108" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "start,Switch" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#start%2CSwitch" > < span class = "Identifier" > start< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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 >
2023-12-18 18:06:09 +00:00
< dd >
Start listening on every transport
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L305"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L305" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "stop,Switch" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#stop%2CSwitch" > < span class = "Identifier" > stop< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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 >
2023-12-18 18:06:09 +00:00
< 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 >
Stop listening on every transport, and close every active connections
< a
2024-06-21 11:15:12 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L273"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-21 11:15:12 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L273" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "14" >
< h1 > < a class = "toc-backref" href = "#14" > Methods< / a > < / h1 >
< dl class = "item" >
< div id = "addTransport.e,Switch,Transport" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#addTransport.e%2CSwitch%2CTransport" > < span class = "Identifier" > addTransport< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < a href = "upgrademngrs/upgrade.html#Transport" > < span class = "Identifier" > Transport< / 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 >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L113"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L113" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "connect.e,Switch,MultiAddress" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#connect.e%2CSwitch%2CMultiAddress" > < span class = "Identifier" > connect< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > address< / span > < span class = "Other" > :< / span > < a href = "multiaddress.html#MultiAddress" > < span class = "Identifier" > MultiAddress< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > allowUnknownPeerId< / span > < span class = "Other" > =< / span > < span class = "Identifier" > false< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span >
< 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" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< p > Connects to a peer and retrieve its PeerId< / p >
< p > If the P2P part is missing from the MA and < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > allowUnknownPeerId< / span > < / span > < / tt > is set to true, this will discover the PeerId while connecting. This exposes you to MiTM attacks, so it shouldn't be used without care!< / p >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L143"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L143" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "connect.e,Switch,PeerId,seq[MultiAddress]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#connect.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D" > < span class = "Identifier" > connect< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > 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 >
2024-04-29 13:39:28 +00:00
< span class = "Identifier" > forceDial< / span > < span class = "Other" > =< / span > < span class = "Identifier" > false< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > reuseConnection< / span > < span class = "Other" > =< / span > < span class = "Identifier" > true< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > dir< / span > < span class = "Other" > =< / span > < a href = "stream/lpstream.html#Direction" > < span class = "Identifier" > Direction< / span > < / a > < span class = "Other" > .< / span > < span class = "Identifier" > Out< / 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" > public< / 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 >
2023-12-18 18:06:09 +00:00
< dd >
Connects to a peer without opening a stream to it
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L131"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L131" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "dial.e,Switch,PeerId,seq[MultiAddress],seq[string]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#dial.e%2CSwitch%2CPeerId%2Cseq%5BMultiAddress%5D%2Cseq%5Bstring%5D" > < span class = "Identifier" > dial< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > 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 = "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 = "Identifier" > forceDial< / span > < span class = "Other" > =< / span > < span class = "Identifier" > false< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < a href = "stream/connection.html#Connection" > < span class = "Identifier" > Connection< / span > < / a > < span class = "Other" > ]< / span > {.
< span class = "Identifier" > public< / 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 >
Connected to a peer and open a stream with the specified < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > protos< / span > < / span > < / tt >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L166"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L166" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "dial.e,Switch,PeerId,seq[string]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#dial.e%2CSwitch%2CPeerId%2Cseq%5Bstring%5D" > < span class = "Identifier" > dial< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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 > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < a href = "stream/connection.html#Connection" > < span class = "Identifier" > Connection< / span > < / a > < span class = "Other" > ]< / span > {.
< span class = "Identifier" > public< / 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 >
Open a stream to a connected peer with the specified < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > protos< / span > < / span > < / tt >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L154"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L154" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "run.e,Service,Switch" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#run.e%2CService%2CSwitch" > < span class = "Identifier" > run< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > self< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Service" > < span class = "Identifier" > Service< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > switch< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / 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" > base< / 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 >
2023-12-18 18:06:09 +00:00
< span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L74"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L74" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "setup.e,Service,Switch" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#setup.e%2CService%2CSwitch" > < span class = "Identifier" > setup< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > self< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Service" > < span class = "Identifier" > Service< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > switch< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < span class = "Identifier" > bool< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > base< / 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 >
2023-12-18 18:06:09 +00:00
< span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L67"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L67" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "stop.e,Service,Switch" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#stop.e%2CService%2CSwitch" > < span class = "Identifier" > stop< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > self< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Service" > < span class = "Identifier" > Service< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > switch< / span > < span class = "Other" > :< / span > < a href = "transports/transport.html#Switch" > < span class = "Identifier" > Switch< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < span class = "Identifier" > bool< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > base< / 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 >
2023-12-18 18:06:09 +00:00
< span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/switch.nim#L77"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-19 14:49:07 +00:00
< a href = "https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/switch.nim#L77" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "19" >
< h1 > < a class = "toc-backref" href = "#19" > Exports< / a > < / h1 >
< dl class = "item" >
2024-09-12 10:26:15 +00:00
< a href = "peerstore.html#ConnManager" > < span class = "Identifier" > ConnManager< / span > < / a > , < a href = "peerstore.html#getStream,ConnManager,PeerId,Direction" > < span class = "Identifier" > getStream< / span > < / a > , < a href = "peerstore.html#PeerEventKind" > < span class = "Identifier" > PeerEventKind< / span > < / a > , < a href = "peerstore.html#getStream,ConnManager,Muxer" > < span class = "Identifier" > getStream< / span > < / a > , < a href = "peerstore.html#addPeerEventHandler,ConnManager,PeerEventHandler,PeerEventKind" > < span class = "Identifier" > addPeerEventHandler< / span > < / a > , < a href = "peerstore.html#new,typeConnManager,int,int" > < span class = "Identifier" > new< / span > < / a > , < a href = "peerstore.html#ConnEventKind" > < span class = "Identifier" > ConnEventKind< / span > < / a > , < a href = "peerstore.html#PeerEventHandler" > < span class = "Identifier" > PeerEventHandler< / span > < / a > , < a href = "peerstore.html#selectMuxer,ConnManager,PeerId,Direction" > < span class = "Identifier" > selectMuxer< / span > < / a > , < a href = "peerstore.html#getConnections,ConnManager" > < span class = "Identifier" > getConnections< / span > < / a > , < a href = "peerstore.html#contains,ConnManager,Muxer" > < span class = "Identifier" > contains< / span > < / a > , < a href = "peerstore.html#removePeerEventHandler,ConnManager,PeerEventHandler,PeerEventKind" > < span class = "Identifier" > removePeerEventHandler< / span > < / a > , < a href = "peerstore.html#expectConnection,ConnManager,PeerId,Direction" > < span class = "Identifier" > expectConnection< / span > < / a > , < a href = "peerstore.html#ConnEvent" > < span class = "Identifier" > ConnEvent< / span > < / a > , < a href = "peerstore.html#connCount,ConnManager,PeerId" > < span class = "Identifier" > connCount< / span > < / a > , < a href = "peerstore.html#ConnEventHandler" > < span class = "Identifier" > ConnEventHandler< / span > < / a > , < a href = "peerstore.html#addConnEventHandler,ConnManager,ConnEventHandler,ConnEventKind" > < span class = "Identifier" > addConnEventHandler< / span > < / a > , < a href = "peerstore.html#triggerConnEvent,ConnManager,PeerId,ConnEvent" > < span class = "Identifier" > triggerConnEvent< / span > < / a > , < a href = "peerstore.html#removeConnEventHandler,ConnManager,ConnEventHandler,ConnEventKind" > < span class = "Identifier" > removeConnEventHandler< / span > < / a > , < a href = "peerstore.html#contains,ConnManager,PeerId" > < span class = "Identifier" > contains< / span > < / a > , < a href = "peerstore.html#triggerPeerEvents,ConnManager,PeerId,PeerEvent" > < span class = "Identifier" > triggerPeerEvents< / span > < / a > , < a href = "peerstore.html#AlreadyExpectingConnectionError" > < span class = "Identifier" > AlreadyExpectingConnectionError< / span > < / a > , < a href = "peerstore.html#PeerEvent" > < span class = "Identifier" > PeerEvent< / span > < / a > , < a href = "peerstore.html#TooManyConnectionsError" > < span class = "Identifier" > TooManyConnectionsError< / span > < / a > , < a href = "peerstore.html#getStream,ConnManager,PeerId" > < span class = "Identifier" > getStream< / span > < / a > , < a href = "peerstore.html#trackConnection,ConnectionSlot,Connection" > < span class = "Identifier" > trackConnection< / span > < / a > , < a href = "peerstore.html#close,ConnManager" > < span class = "Identifier" > close< / span > < / a > , < a href = "peerstore.html#MaxConnectionsPerPeer" > < span class = "Identifier" > MaxConnectionsPerPeer< / span > < / a > , < a href = "peerstore.html#connectedPeers,ConnManager,Direction" > < span class = "Identifier" > connectedPeers< / span > < / a > , < a href = "peerstore.html#selectMuxer,ConnManager,PeerId" > < span class = "Identifier" > selectMuxer< / span > < / a > , < a href = "peerstore.html#trackMuxer,ConnectionSlot,Muxer" > < span class = "Identifier" > trackMuxer< / span > < / a > , < a href = "peerstore.html#getOutgoingSlot,ConnManager" > < span class = "Identifier" > getOutgoingSlot< / span > < / a > , < a href = "peerstore.html#slotsAvailable,ConnManager,Direction" > < span class = "Identifier" > slotsAvailable< / span > < / a > , < a href = "peerstore.html#dropPeer,ConnManager,PeerId" > < span class = "Identifier" > dropPeer< / span > < / a > , < a href = "peerstore.html#getIncomingSlot,ConnManager" > < span class = "Identifier" > getIncomingSlot< / span > < / a > , < a href = "peerstore.html#storeMuxer,ConnManager,Muxer" > < span class = "Identifier" > storeMuxer< / span > < / a > , < a href = "peerstore.html#release,ConnectionSlot" > < span class = "Identifier" > release< / span > < / a > , < a href = "peerstore.html#MaxConnections" > < span class = "Identifier" > MaxConnections< / span > < /a
2023-12-18 18:06:09 +00:00
< / dl > < / div >
< / div >
< / div >
< div class = "row" >
< div class = "twelve-columns footer" >
< span class = "nim-sprite" > < / span >
< br / >
2024-09-12 10:26:15 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2024-09-12 10:26:03 UTC< / small >
2023-12-18 18:06:09 +00:00
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
