mirror of https://github.com/waku-org/js-waku.git
54 lines
95 KiB
HTML
54 lines
95 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectionManager | Documentation</title><meta name="description" content="Documentation for Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Documentation</a></li><li><a href="../modules/_waku_core.html">@waku/core</a></li><li><a href="_waku_core.ConnectionManager.html">ConnectionManager</a></li></ul><h1>Class ConnectionManager</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypedEventEmitter</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_waku_interfaces.IPeersByDiscoveryEvents.html" class="tsd-signature-type tsd-kind-interface">IPeersByDiscoveryEvents</a><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_waku_interfaces.IConnectionStateEvents.html" class="tsd-signature-type tsd-kind-interface">IConnectionStateEvents</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ConnectionManager</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_waku_interfaces.IConnectionManager.html" class="tsd-signature-type tsd-kind-interface">IConnectionManager</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L28">packages/core/src/lib/connection_manager.ts:28</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_waku_core.ConnectionManager.html#constructor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_waku_core.ConnectionManager.html#_private" class="tsd-index-link tsd-is-private tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#private</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#configuredPubsubTopics" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configured<wbr/>Pubsub<wbr/>Topics</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#currentActiveParallelDialCount" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>Active<wbr/>Parallel<wbr/>Dial<wbr/>Count</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dialAttemptsForPeer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dial<wbr/>Attempts<wbr/>For<wbr/>Peer</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dialErrorsForPeer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dial<wbr/>Errors<wbr/>For<wbr/>Peer</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#keepAliveManager" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Alive<wbr/>Manager</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#libp2p" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libp2p</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#onEventHandlers" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Event<wbr/>Handlers</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#online" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>online</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#options" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#pendingPeerDialQueue" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pending<wbr/>Peer<wbr/>Dial<wbr/>Queue</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#instances" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>instances</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_waku_core.ConnectionManager.html#addEventListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Listener</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#attemptDial" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attempt<wbr/>Dial</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dialPeer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dial<wbr/>Peer</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dialPeerStorePeers" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dial<wbr/>Peer<wbr/>Store<wbr/>Peers</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dispatchDiscoveryEvent" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispatch<wbr/>Discovery<wbr/>Event</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dispatchEvent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispatch<wbr/>Event</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#dropConnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>drop<wbr/>Connection</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#getPeerShardInfo" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Shard<wbr/>Info</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#getPeersByDiscovery" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peers<wbr/>By<wbr/>Discovery</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#getTagNamesForPeer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tag<wbr/>Names<wbr/>For<wbr/>Peer</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#isConnected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Connected</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#isPeerDialableBasedOnBootstrapStatus" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Peer<wbr/>Dialable<wbr/>Based<wbr/>On<wbr/>Bootstrap<wbr/>Status</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#isPeerTopicConfigured" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Peer<wbr/>Topic<wbr/>Configured</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#processDialQueue" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Dial<wbr/>Queue</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#removeEventListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Event<wbr/>Listener</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#run" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#safeDispatchEvent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>safe<wbr/>Dispatch<wbr/>Event</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#shouldDialPeer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Dial<wbr/>Peer</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#startPeerConnectionListener" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Connection<wbr/>Listener</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#startPeerDisconnectionListener" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Disconnection<wbr/>Listener</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#startPeerDiscoveryListener" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Discovery<wbr/>Listener</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#toggleOffline" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Offline</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#toggleOnline" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Online</span></a>
|
||
<a href="_waku_core.ConnectionManager.html#create" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a>
|
||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ConnectionManager" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Connection<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">libp2p</span>, <span class="tsd-kind-parameter">keepAliveOptions</span>, <span class="tsd-kind-parameter">configuredPubsubTopics</span>, <span class="tsd-kind-parameter">relay</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_waku_core.ConnectionManager.html" class="tsd-signature-type tsd-kind-class">ConnectionManager</a><a href="#constructor.new_ConnectionManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">libp2p</span>: <a href="../types/_waku_interfaces.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></span></li><li><span><span class="tsd-kind-parameter">keepAliveOptions</span>: <a href="../interfaces/_waku_interfaces.KeepAliveOptions.html" class="tsd-signature-type tsd-kind-interface">KeepAliveOptions</a></span></li><li><span><span class="tsd-kind-parameter">configuredPubsubTopics</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">relay</span>: <a href="../types/_waku_interfaces.IRelay.html" class="tsd-signature-type tsd-kind-type-alias">IRelay</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_waku_interfaces.ConnectionManagerOptions.html" class="tsd-signature-type tsd-kind-interface">ConnectionManagerOptions</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_waku_core.ConnectionManager.html" class="tsd-signature-type tsd-kind-class">ConnectionManager</a></h4><aside class="tsd-sources"><p>Overrides TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>.constructor</p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L173">packages/core/src/lib/connection_manager.ts:173</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited tsd-is-external"><a id="_private" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#private</span><a href="#_private" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#private</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#_private">#private</a></p><p>Inherited from TypedEventEmitter.#private</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="configuredPubsubTopics" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>configured<wbr/>Pubsub<wbr/>Topics</span><a href="#configuredPubsubTopics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configured<wbr/>Pubsub<wbr/>Topics</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L176">packages/core/src/lib/connection_manager.ts:176</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="currentActiveParallelDialCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>current<wbr/>Active<wbr/>Parallel<wbr/>Dial<wbr/>Count</span><a href="#currentActiveParallelDialCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">current<wbr/>Active<wbr/>Parallel<wbr/>Dial<wbr/>Count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L39">packages/core/src/lib/connection_manager.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="dialAttemptsForPeer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dial<wbr/>Attempts<wbr/>For<wbr/>Peer</span><a href="#dialAttemptsForPeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dial<wbr/>Attempts<wbr/>For<wbr/>Peer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L36">packages/core/src/lib/connection_manager.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="dialErrorsForPeer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dial<wbr/>Errors<wbr/>For<wbr/>Peer</span><a href="#dialErrorsForPeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dial<wbr/>Errors<wbr/>For<wbr/>Peer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L37">packages/core/src/lib/connection_manager.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="keepAliveManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>keep<wbr/>Alive<wbr/>Manager</span><a href="#keepAliveManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keep<wbr/>Alive<wbr/>Manager</span><span class="tsd-signature-symbol">:</span> <a href="_waku_core.KeepAliveManager.html" class="tsd-signature-type tsd-kind-class">KeepAliveManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L33">packages/core/src/lib/connection_manager.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="libp2p" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>libp2p</span><a href="#libp2p" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">libp2p</span><span class="tsd-signature-symbol">:</span> <a href="../types/_waku_interfaces.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L35">packages/core/src/lib/connection_manager.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="onEventHandlers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>on<wbr/>Event<wbr/>Handlers</span><a href="#onEventHandlers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Event<wbr/>Handlers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">peer:connect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">peer:disconnect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">peer:discovery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">peer:connect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="onEventHandlers.__type.peer_connect.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">evt</span>: <span class="tsd-signature-type">CustomEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerId</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">peer:disconnect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="onEventHandlers.__type.peer_disconnect.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">evt</span>: <span class="tsd-signature-type">CustomEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerId</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">peer:discovery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="onEventHandlers.__type.peer_discovery.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">evt</span>: <span class="tsd-signature-type">CustomEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerInfo</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L375">packages/core/src/lib/connection_manager.ts:375</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="online" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>online</span><a href="#online" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">online</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L41">packages/core/src/lib/connection_manager.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_waku_interfaces.ConnectionManagerOptions.html" class="tsd-signature-type tsd-kind-interface">ConnectionManagerOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L34">packages/core/src/lib/connection_manager.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="pendingPeerDialQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>pending<wbr/>Peer<wbr/>Dial<wbr/>Queue</span><a href="#pendingPeerDialQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pending<wbr/>Peer<wbr/>Dial<wbr/>Queue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PeerId</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L40">packages/core/src/lib/connection_manager.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="instances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagStatic">Static</code> <span>instances</span><a href="#instances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">instances</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="_waku_core.ConnectionManager.html" class="tsd-signature-type tsd-kind-class">ConnectionManager</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L32">packages/core/src/lib/connection_manager.ts:32</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEventListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Listener</span><a href="#addEventListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addEventListener.addEventListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Listener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#addEventListener.addEventListener-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">listener</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addEventListener.addEventListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="addEventListener.addEventListener-1.K" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><a href="../enums/_waku_interfaces.EConnectionStateEvents.html#CONNECTION_STATUS" class="tsd-signature-type tsd-kind-enum-member">CONNECTION_STATUS</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>keyof IPeersByDiscoveryEvents<span class="tsd-signature-symbol">)</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#addEventListener.addEventListener-1.K">K</a></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventHandler</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><a href="../interfaces/_waku_interfaces.IPeersByDiscoveryEvents.html" class="tsd-signature-type tsd-kind-interface">IPeersByDiscoveryEvents</a><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_waku_interfaces.IConnectionStateEvents.html" class="tsd-signature-type tsd-kind-interface">IConnectionStateEvents</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#addEventListener.addEventListener-1.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AddEventListenerOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#addEventListener">addEventListener</a></p><p>Inherited from TypedEventEmitter.addEventListener</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:31</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="attemptDial" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>attempt<wbr/>Dial</span><a href="#attemptDial" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="attemptDial.attemptDial-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">attempt<wbr/>Dial</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#attemptDial.attemptDial-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L364">packages/core/src/lib/connection_manager.ts:364</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="dialPeer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dial<wbr/>Peer</span><a href="#dialPeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="dialPeer.dialPeer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dial<wbr/>Peer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dialPeer.dialPeer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L235">packages/core/src/lib/connection_manager.ts:235</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="dialPeerStorePeers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dial<wbr/>Peer<wbr/>Store<wbr/>Peers</span><a href="#dialPeerStorePeers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="dialPeerStorePeers.dialPeerStorePeers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dial<wbr/>Peer<wbr/>Store<wbr/>Peers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dialPeerStorePeers.dialPeerStorePeers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L210">packages/core/src/lib/connection_manager.ts:210</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="dispatchDiscoveryEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dispatch<wbr/>Discovery<wbr/>Event</span><a href="#dispatchDiscoveryEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="dispatchDiscoveryEvent.dispatchDiscoveryEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispatch<wbr/>Discovery<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dispatchDiscoveryEvent.dispatchDiscoveryEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L519">packages/core/src/lib/connection_manager.ts:519</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dispatchEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dispatch<wbr/>Event</span><a href="#dispatchEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="dispatchEvent.dispatchEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispatch<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#dispatchEvent.dispatchEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">Event</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#dispatchEvent">dispatchEvent</a></p><p>Inherited from TypedEventEmitter.dispatchEvent</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:33</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dropConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>drop<wbr/>Connection</span><a href="#dropConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dropConnection.dropConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">drop<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dropConnection.dropConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#dropConnection">dropConnection</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L108">packages/core/src/lib/connection_manager.ts:108</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getPeerShardInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Peer<wbr/>Shard<wbr/>Info</span><a href="#getPeerShardInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getPeerShardInfo.getPeerShardInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Peer<wbr/>Shard<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span>, <span class="tsd-kind-parameter">peerStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_waku_interfaces.ShardInfo.html" class="tsd-signature-type tsd-kind-interface">ShardInfo</a><span class="tsd-signature-symbol">></span><a href="#getPeerShardInfo.getPeerShardInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li><li><span><span class="tsd-kind-parameter">peerStore</span>: <span class="tsd-signature-type">PeerStore</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_waku_interfaces.ShardInfo.html" class="tsd-signature-type tsd-kind-interface">ShardInfo</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L566">packages/core/src/lib/connection_manager.ts:566</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPeersByDiscovery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Peers<wbr/>By<wbr/>Discovery</span><a href="#getPeersByDiscovery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getPeersByDiscovery.getPeersByDiscovery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Peers<wbr/>By<wbr/>Discovery</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_waku_interfaces.PeersByDiscoveryResult.html" class="tsd-signature-type tsd-kind-interface">PeersByDiscoveryResult</a><span class="tsd-signature-symbol">></span><a href="#getPeersByDiscovery.getPeersByDiscovery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_waku_interfaces.PeersByDiscoveryResult.html" class="tsd-signature-type tsd-kind-interface">PeersByDiscoveryResult</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#getPeersByDiscovery">getPeersByDiscovery</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L120">packages/core/src/lib/connection_manager.ts:120</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getTagNamesForPeer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Tag<wbr/>Names<wbr/>For<wbr/>Peer</span><a href="#getTagNamesForPeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getTagNamesForPeer.getTagNamesForPeer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tag<wbr/>Names<wbr/>For<wbr/>Peer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getTagNamesForPeer.getTagNamesForPeer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches the tag names for a given peer</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L539">packages/core/src/lib/connection_manager.ts:539</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isConnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isConnected.isConnected-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Connected</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isConnected.isConnected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L43">packages/core/src/lib/connection_manager.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="isPeerDialableBasedOnBootstrapStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>is<wbr/>Peer<wbr/>Dialable<wbr/>Based<wbr/>On<wbr/>Bootstrap<wbr/>Status</span><a href="#isPeerDialableBasedOnBootstrapStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="isPeerDialableBasedOnBootstrapStatus.isPeerDialableBasedOnBootstrapStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Peer<wbr/>Dialable<wbr/>Based<wbr/>On<wbr/>Bootstrap<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#isPeerDialableBasedOnBootstrapStatus.isPeerDialableBasedOnBootstrapStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if the peer is dialable based on the following conditions:</p>
|
||
<ol>
|
||
<li>If the peer is a bootstrap peer, it is only dialable if the number of current bootstrap connections is less than the max allowed.</li>
|
||
<li>If the peer is not a bootstrap peer</li>
|
||
</ol>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L499">packages/core/src/lib/connection_manager.ts:499</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="isPeerTopicConfigured" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>is<wbr/>Peer<wbr/>Topic<wbr/>Configured</span><a href="#isPeerTopicConfigured" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="isPeerTopicConfigured.isPeerTopicConfigured-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Peer<wbr/>Topic<wbr/>Configured</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#isPeerTopicConfigured.isPeerTopicConfigured-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L549">packages/core/src/lib/connection_manager.ts:549</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="listenerCount.listenerCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#listenerCount">listenerCount</a></p><p>Inherited from TypedEventEmitter.listenerCount</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:30</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="processDialQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>process<wbr/>Dial<wbr/>Queue</span><a href="#processDialQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="processDialQueue.processDialQueue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">process<wbr/>Dial<wbr/>Queue</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#processDialQueue.processDialQueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L318">packages/core/src/lib/connection_manager.ts:318</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeEventListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Event<wbr/>Listener</span><a href="#removeEventListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removeEventListener.removeEventListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Event<wbr/>Listener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#removeEventListener.removeEventListener-1.K-1">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeEventListener.removeEventListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="removeEventListener.removeEventListener-1.K-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><a href="../enums/_waku_interfaces.EConnectionStateEvents.html#CONNECTION_STATUS" class="tsd-signature-type tsd-kind-enum-member">CONNECTION_STATUS</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>keyof IPeersByDiscoveryEvents<span class="tsd-signature-symbol">)</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#removeEventListener.removeEventListener-1.K-1">K</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventHandler</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><a href="../interfaces/_waku_interfaces.IPeersByDiscoveryEvents.html" class="tsd-signature-type tsd-kind-interface">IPeersByDiscoveryEvents</a><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_waku_interfaces.IConnectionStateEvents.html" class="tsd-signature-type tsd-kind-interface">IConnectionStateEvents</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#removeEventListener.removeEventListener-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListenerOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#removeEventListener">removeEventListener</a></p><p>Inherited from TypedEventEmitter.removeEventListener</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:32</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="run" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="run.run-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#run.run-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L228">packages/core/src/lib/connection_manager.ts:228</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="safeDispatchEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>safe<wbr/>Dispatch<wbr/>Event</span><a href="#safeDispatchEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="safeDispatchEvent.safeDispatchEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">safe<wbr/>Dispatch<wbr/>Event</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#safeDispatchEvent.safeDispatchEvent-1.Detail">Detail</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">detail</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#safeDispatchEvent.safeDispatchEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="safeDispatchEvent.safeDispatchEvent-1.Detail" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Detail</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a href="../enums/_waku_interfaces.EConnectionStateEvents.html#CONNECTION_STATUS" class="tsd-signature-type tsd-kind-enum-member">CONNECTION_STATUS</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>keyof IPeersByDiscoveryEvents<span class="tsd-signature-symbol">)</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">detail</span>: <span class="tsd-signature-type">CustomEventInit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_waku_core.ConnectionManager.html#safeDispatchEvent.safeDispatchEvent-1.Detail">Detail</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#safeDispatchEvent">safeDispatchEvent</a></p><p>Inherited from TypedEventEmitter.safeDispatchEvent</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:34</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="shouldDialPeer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>should<wbr/>Dial<wbr/>Peer</span><a href="#shouldDialPeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="shouldDialPeer.shouldDialPeer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">should<wbr/>Dial<wbr/>Peer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#shouldDialPeer.shouldDialPeer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if the peer should be dialed based on the following conditions:</p>
|
||
<ol>
|
||
<li>If the peer is already connected, don't dial</li>
|
||
<li>If the peer is not part of any of the configured pubsub topics, don't dial</li>
|
||
<li>If the peer is not dialable based on bootstrap status, don't dial</li>
|
||
<li>If the peer is already has an active dial attempt, or has been dialed before, don't dial it</li>
|
||
</ol>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">PeerId</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>true if the peer should be dialed, false otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L450">packages/core/src/lib/connection_manager.ts:450</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="startPeerConnectionListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Peer<wbr/>Connection<wbr/>Listener</span><a href="#startPeerConnectionListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="startPeerConnectionListener.startPeerConnectionListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Peer<wbr/>Connection<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startPeerConnectionListener.startPeerConnectionListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L338">packages/core/src/lib/connection_manager.ts:338</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="startPeerDisconnectionListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Peer<wbr/>Disconnection<wbr/>Listener</span><a href="#startPeerDisconnectionListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="startPeerDisconnectionListener.startPeerDisconnectionListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Peer<wbr/>Disconnection<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startPeerDisconnectionListener.startPeerDisconnectionListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L345">packages/core/src/lib/connection_manager.ts:345</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="startPeerDiscoveryListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Peer<wbr/>Discovery<wbr/>Listener</span><a href="#startPeerDiscoveryListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="startPeerDiscoveryListener.startPeerDiscoveryListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Peer<wbr/>Discovery<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startPeerDiscoveryListener.startPeerDiscoveryListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L331">packages/core/src/lib/connection_manager.ts:331</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stop.stop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stop</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stop.stop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_interfaces.IConnectionManager.html">IConnectionManager</a>.<a href="../interfaces/_waku_interfaces.IConnectionManager.html#stop">stop</a></p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L92">packages/core/src/lib/connection_manager.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="toggleOffline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>toggle<wbr/>Offline</span><a href="#toggleOffline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="toggleOffline.toggleOffline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toggle<wbr/>Offline</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#toggleOffline.toggleOffline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L58">packages/core/src/lib/connection_manager.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="toggleOnline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>toggle<wbr/>Online</span><a href="#toggleOnline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="toggleOnline.toggleOnline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toggle<wbr/>Online</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#toggleOnline.toggleOnline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L47">packages/core/src/lib/connection_manager.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="create.create-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peerId</span>, <span class="tsd-kind-parameter">libp2p</span>, <span class="tsd-kind-parameter">keepAliveOptions</span>, <span class="tsd-kind-parameter">pubsubTopics</span>, <span class="tsd-kind-parameter">relay</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_waku_core.ConnectionManager.html" class="tsd-signature-type tsd-kind-class">ConnectionManager</a><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peerId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">libp2p</span>: <a href="../types/_waku_interfaces.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></span></li><li><span><span class="tsd-kind-parameter">keepAliveOptions</span>: <a href="../interfaces/_waku_interfaces.KeepAliveOptions.html" class="tsd-signature-type tsd-kind-interface">KeepAliveOptions</a></span></li><li><span><span class="tsd-kind-parameter">pubsubTopics</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">relay</span>: <a href="../types/_waku_interfaces.IRelay.html" class="tsd-signature-type tsd-kind-type-alias">IRelay</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_waku_interfaces.ConnectionManagerOptions.html" class="tsd-signature-type tsd-kind-interface">ConnectionManagerOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_waku_core.ConnectionManager.html" class="tsd-signature-type tsd-kind-class">ConnectionManager</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/86f730f95/packages/core/src/lib/connection_manager.ts#L69">packages/core/src/lib/connection_manager.ts:69</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_private" class="tsd-is-private tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#private</span></a><a href="#configuredPubsubTopics" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configured<wbr/>Pubsub<wbr/>Topics</span></a><a href="#currentActiveParallelDialCount" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>Active<wbr/>Parallel<wbr/>Dial<wbr/>Count</span></a><a href="#dialAttemptsForPeer" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dial<wbr/>Attempts<wbr/>For<wbr/>Peer</span></a><a href="#dialErrorsForPeer" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dial<wbr/>Errors<wbr/>For<wbr/>Peer</span></a><a href="#keepAliveManager" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Alive<wbr/>Manager</span></a><a href="#libp2p" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libp2p</span></a><a href="#onEventHandlers" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Event<wbr/>Handlers</span></a><a href="#online" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>online</span></a><a href="#options" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#pendingPeerDialQueue" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pending<wbr/>Peer<wbr/>Dial<wbr/>Queue</span></a><a href="#instances" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>instances</span></a><a href="#addEventListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Listener</span></a><a href="#attemptDial" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attempt<wbr/>Dial</span></a><a href="#dialPeer" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dial<wbr/>Peer</span></a><a href="#dialPeerStorePeers" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dial<wbr/>Peer<wbr/>Store<wbr/>Peers</span></a><a href="#dispatchDiscoveryEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispatch<wbr/>Discovery<wbr/>Event</span></a><a href="#dispatchEvent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispatch<wbr/>Event</span></a><a href="#dropConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>drop<wbr/>Connection</span></a><a href="#getPeerShardInfo" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Shard<wbr/>Info</span></a><a href="#getPeersByDiscovery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peers<wbr/>By<wbr/>Discovery</span></a><a href="#getTagNamesForPeer" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tag<wbr/>Names<wbr/>For<wbr/>Peer</span></a><a href="#isConnected" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Connected</span></a><a href="#isPeerDialableBasedOnBootstrapStatus" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Peer<wbr/>Dialable<wbr/>Based<wbr/>On<wbr/>Bootstrap<wbr/>Status</span></a><a href="#isPeerTopicConfigured" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Peer<wbr/>Topic<wbr/>Configured</span></a><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#processDialQueue" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Dial<wbr/>Queue</span></a><a href="#removeEventListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Event<wbr/>Listener</span></a><a href="#run" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run</span></a><a href="#safeDispatchEvent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>safe<wbr/>Dispatch<wbr/>Event</span></a><a href="#shouldDialPeer" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Dial<wbr/>Peer</span></a><a href="#startPeerConnectionListener" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Connection<wbr/>Listener</span></a><a href="#startPeerDisconnectionListener" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Disconnection<wbr/>Listener</span></a><a href="#startPeerDiscoveryListener" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Peer<wbr/>Discovery<wbr/>Listener</span></a><a href="#stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a><a href="#toggleOffline" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Offline</span></a><a href="#toggleOnline" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Online</span></a><a href="#create" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html> |