2024-02-15 18:36:48 +00:00
<!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/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" </ 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 = "#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 = "#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/a787e306b/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 = "#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 = "#icon-512" ></ use ></ svg >< span > constructor</ span ></ a >
2023-11-28 15:58:49 +00:00
</ 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 = "#icon-1024" ></ use ></ svg >< span > #private</ span ></ a >
2023-11-14 15:55:04 +00:00
< 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 = "#icon-1024" ></ use ></ svg >< span > configured< wbr /> Pubsub< wbr /> Topics</ span ></ a >
2023-10-20 12:48:57 +00:00
< 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 = "#icon-1024" ></ use ></ svg >< span > current< wbr /> Active< wbr /> Parallel< wbr /> Dial< wbr /> Count</ span ></ a >
2023-09-21 08:59:21 +00:00
< 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 = "#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 = "#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 = "#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 = "#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 = "#icon-1024" ></ use ></ svg >< span > on< wbr /> Event< wbr /> Handlers</ span ></ a >
2023-11-27 11:46:51 +00:00
< 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 = "#icon-1024" ></ use ></ svg >< span > online</ span ></ a >
2023-09-21 08:59:21 +00:00
< 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 = "#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 = "#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 = "#icon-1024" ></ use ></ svg >< span > instances</ span ></ a >
2023-11-28 15:58:49 +00:00
</ 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 = "#icon-2048" ></ use ></ svg >< span > add< wbr /> Event< wbr /> Listener</ span ></ a >
2023-09-21 08:59:21 +00:00
< a href = "_waku_core.ConnectionManager.html#attemptDial" class = "tsd-index-link tsd-is-private" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#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 = "#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 = "#icon-2048" ></ use ></ svg >< span > dial< wbr /> Peer< wbr /> Store< wbr /> Peers</ span ></ a >
2023-10-13 12:40:34 +00:00
< 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 = "#icon-2048" ></ use ></ svg >< span > dispatch< wbr /> Discovery< wbr /> Event</ span ></ a >
2023-09-21 08:59:21 +00:00
< 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 = "#icon-2048" ></ use ></ svg >< span > dispatch< wbr /> Event</ span ></ a >
< a href = "_waku_core.ConnectionManager.html#dropConnection" class = "tsd-index-link tsd-is-private" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2048" ></ use ></ svg >< span > drop< wbr /> Connection</ span ></ a >
2023-10-10 14:50:25 +00:00
< 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 = "#icon-2048" ></ use ></ svg >< span > get< wbr /> Peer< wbr /> Shard< wbr /> Info</ span ></ a >
2023-09-21 08:59:21 +00:00
< a href = "_waku_core.ConnectionManager.html#getPeersByDiscovery" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#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 = "#icon-2048" ></ use ></ svg >< span > get< wbr /> Tag< wbr /> Names< wbr /> For< wbr /> Peer</ span ></ a >
2023-11-27 11:46:51 +00:00
< a href = "_waku_core.ConnectionManager.html#isConnected" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2048" ></ use ></ svg >< span > is< wbr /> Connected</ span ></ a >
2023-10-13 12:40:34 +00:00
< 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 = "#icon-2048" ></ use ></ svg >< span > is< wbr /> Peer< wbr /> Dialable< wbr /> Based< wbr /> On< wbr /> Bootstrap< wbr /> Status</ span ></ a >
2023-10-10 14:50:25 +00:00
< 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 = "#icon-2048" ></ use ></ svg >< span > is< wbr /> Peer< wbr /> Topic< wbr /> Configured</ span ></ a >
2023-09-21 08:59:21 +00:00
< 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 = "#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 = "#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 = "#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 = "#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 = "#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 = "#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 = "#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 = "#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 = "#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 = "#icon-2048" ></ use ></ svg >< span > stop</ span ></ a >
2023-11-27 11:46:51 +00:00
< 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 = "#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 = "#icon-2048" ></ use ></ svg >< span > toggle< wbr /> Online</ span ></ a >
2023-09-21 08:59:21 +00:00
< a href = "_waku_core.ConnectionManager.html#create" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2048" ></ use ></ svg >< span > create</ span ></ a >
2024-02-15 18:36:48 +00:00
</ 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 = "#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 = "#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 >< h5 >< span class = "tsd-kind-parameter" > libp2p</ span > : < a href = "../types/_waku_interfaces.Libp2p.html" class = "tsd-signature-type tsd-kind-type-alias" > Libp2p</ a ></ h5 ></ li >< li >< h5 >< span class = "tsd-kind-parameter" > keepAliveOptions</ span > : < a href = "../interfaces/_waku_interfaces.KeepAliveOptions.html" class = "tsd-signature-type tsd-kind-interface" > KeepAliveOptions</ a ></ h5 ></ li >< li >< h5 >< span class = "tsd-kind-parameter" > configuredPubsubTopics</ span > : < span class = "tsd-signature-type" > string</ span >< span class = "tsd-signature-symbol" > []</ span ></ h5 ></ li >< li >< h5 >< 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 ></ h5 ></ li >< li >< h5 >< 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 ></ h5 ></ 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/a787e306b/packages/core/src/lib/connection_manager.ts#L136" > packages/core/src/lib/connection_manager.ts:136</ 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 = "#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" > #p
</ div >< div class = "tsd-parameters" >< h4 class = "tsd-parameters-title" > Parameters</ h4 >< ul class = "tsd-parameter-list" >< li >< h5 >< span class = "tsd-kind-parameter" > peerId</ span > : < span class = "tsd-signature-type" > PeerId</ span ></ h5 ></ 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/a787e306b/packages/core/src/lib/connection_manager.ts#L531" > packages/core/src/lib/connection_manager.ts:531</ 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 = "#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 = "#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/a787e306b/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 = "#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 = "#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 >
2023-10-13 12:40:34 +00:00
< 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 >
2024-02-15 18:36:48 +00:00
</ div >< div class = "tsd-parameters" >< h4 class = "tsd-parameters-title" > Parameters</ h4 >< ul class = "tsd-parameter-list" >< li >< h5 >< span class = "tsd-kind-parameter" > peerId</ span > : < span class = "tsd-signature-type" > PeerId</ span ></ h5 ></ 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/a787e306b/packages/core/src/lib/connection_manager.ts#L489" > packages/core/src/lib/connection_manager.ts:489</ 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 = "#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 = "#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 >< h5 >< span class = "tsd-kind-parameter" > peerId</ span > : < span class = "tsd-signature-type" > PeerId</ span ></ h5 ></ 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/a787e306b/packages/core/src/lib/connection_manager.ts#L541" > packages/core/src/lib/connection_manager.ts:541</ 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 = "#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 = "#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 >< h5 >< span class = "tsd-kind-parameter" > type</ span > : < span class = "tsd-signature-type" > string</ span ></ h5 ></ 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_i
2023-02-20 10:02:28 +00:00
<ol>
2023-10-13 12:40:34 +00:00
<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>
2023-10-20 12:48:57 +00:00
<li>If the peer is already has an active dial attempt, or has been dialed before, don't dial it</li>
2023-02-20 10:02:28 +00:00
</ol>
2024-02-01 23:33:30 +00:00
</div><div class=" tsd-parameters " >< h4 class = "tsd-parameters-title" > Parameters</ h4 >< ul class = "tsd-parameter-list" >< li >< h5 >< span class = "tsd-kind-parameter" > peerId</ span > : < span class = "tsd-signature-type" > PeerId</ span ></ h5 ></ 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 >
2024-02-15 18:36:48 +00:00
< 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/a787e306b/packages/core/src/lib/connection_manager.ts#L442" > packages/core/src/lib/connection_manager.ts:442</ 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 = "#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 = "#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/a787e306b/packages/core/src/lib/connection_manager.ts#L324" > packages/core/src/lib/connection_manager.ts:324</ 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 = "#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 = "#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/a787e306b/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 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 = "#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 = "#icon-anch
