2024-01-16 18:17:31 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" >< head >< meta charSet = "utf-8" />< meta http-equiv = "x-ua-compatible" content = "IE=edge" />< title > ConnectionManagerOptions | 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_interfaces.html" > @waku/interfaces</ a ></ li >< li >< a href = "_waku_interfaces.ConnectionManagerOptions.html" > ConnectionManagerOptions</ a ></ li ></ ul >< h1 > Interface ConnectionManagerOptions</ h1 ></ div >< div class = "tsd-signature" >< span class = "tsd-signature-keyword" > interface </ span >< span class = "tsd-kind-interface" > ConnectionManagerOptions </ span >< span class = "tsd-signature-symbol" > { </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.ConnectionManagerOptions.html#maxBootstrapPeersAllowed" > maxBootstrapPeersAllowed</ a >< span class = "tsd-signature-symbol" > : </ span >< span class = "tsd-signature-type" > number</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.ConnectionManagerOptions.html#maxDialAttemptsForPeer" > maxDialAttemptsForPeer</ a >< span class = "tsd-signature-symbol" > : </ span >< span class = "tsd-signature-type" > number</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.ConnectionManagerOptions.html#maxParallelDials" > maxParallelDials</ a >< span class = "tsd-signature-symbol" > : </ span >< span class = "tsd-signature-type" > number</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< 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/00bd51a42/packages/interfaces/src/connection_manager.ts#L10" > packages/interfaces/src/connection_manager.ts:10</ 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" > Properties</ h3 >< div class = "tsd-index-list" >< a href = "_waku_interfaces.ConnectionManagerOptions.html#maxBootstrapPeersAllowed" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewB
2023-09-21 08:59:21 +00:00
< a href = "_waku_interfaces.ConnectionManagerOptions.html#maxDialAttemptsForPeer" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1024" ></ use ></ svg >< span > max< wbr /> Dial< wbr /> Attempts< wbr /> For< wbr /> Peer</ span ></ a >
< a href = "_waku_interfaces.ConnectionManagerOptions.html#maxParallelDials" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1024" ></ use ></ svg >< span > max< wbr /> Parallel< wbr /> Dials</ span ></ a >
2023-11-28 15:58:49 +00:00
</ div ></ section ></ div ></ details ></ section ></ section >< section class = "tsd-panel-group tsd-member-group" >< h2 > Properties</ h2 >< section class = "tsd-panel tsd-member" >< a id = "maxBootstrapPeersAllowed" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< span > max< wbr /> Bootstrap< wbr /> Peers< wbr /> Allowed</ span >< a href = "#maxBootstrapPeersAllowed" 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" > max< wbr /> Bootstrap< wbr /> Peers< wbr /> Allowed</ span >< span class = "tsd-signature-symbol" > :</ span > < span class = "tsd-signature-type" > number</ span ></ div >< div class = "tsd-comment tsd-typography" >< p > Max number of bootstrap peers allowed to be connected to, initially
2023-02-20 10:02:28 +00:00
This is used to increase intention of dialing non-bootstrap peers, found using other discovery mechanisms (like Peer Exchange)</ p >
2024-01-16 18:17:31 +00:00
</ div >< 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/00bd51a42/packages/interfaces/src/connection_manager.ts#L20" > packages/interfaces/src/connection_manager.ts:20</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "maxDialAttemptsForPeer" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< span > max< wbr /> Dial< wbr /> Attempts< wbr /> For< wbr /> Peer</ span >< a href = "#maxDialAttemptsForPeer" 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" > max< wbr /> Dial< wbr /> Attempts< wbr /> For< wbr /> Peer</ span >< span class = "tsd-signature-symbol" > :</ span > < span class = "tsd-signature-type" > number</ span ></ div >< div class = "tsd-comment tsd-typography" >< p > Number of attempts before a peer is considered non-dialable
2023-02-20 10:02:28 +00:00
This is used to not spam a peer with dial attempts when it is not dialable</ p >
2024-01-16 18:17:31 +00:00
</ div >< 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/00bd51a42/packages/interfaces/src/connection_manager.ts#L15" > packages/interfaces/src/connection_manager.ts:15</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "maxParallelDials" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< span > max< wbr /> Parallel< wbr /> Dials</ span >< a href = "#maxParallelDials" 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" > max< wbr /> Parallel< wbr /> Dials</ span >< span class = "tsd-signature-symbol" > :</ span > < span class = "tsd-signature-type" > number</ span ></ div >< div class = "tsd-comment tsd-typography" >< p > Max number of parallel dials allowed</ p >
</ div >< 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/00bd51a42/packages/interfaces/src/connection_manager.ts#L24" > packages/interfaces/src/connection_manager.ts:24</ a ></ li ></ ul ></ aside ></ 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 = "#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 = "#icon-chevronDown" ></ use ></ svg > On This Page</ h3 ></ summary >< div class = "tsd-accordion-details" >< ul >< li >< a href = "#maxBootstrapPeersAllowed" class = "" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1024" ></ use ></ svg >< span > max< wbr /> Bootstrap< wbr /> Peers< wbr /> Allowed</ span ></ a ></ li >< li >< a href = "#maxDialAttemptsForPeer" class = "" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1024" ></ use ></ svg >< span > max< wbr /> Dial< wbr /> Attempts< wbr /> For< wbr /> Peer</ span ></ a ></ li >< li >< a href = "#maxParallelDials" class = "" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1024" ></ use ></ svg >< span > max< wbr /> Parallel< wbr /> Dials</ span ></ a ></ li ></ ul ></ 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 = "#icon-1" ></ use ></ svg >< span > Documentation</ span ></ a >< ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" data-base = ".." >< li >< a href = "../modules/_waku_interfaces.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > @waku/interfaces - v0.0.21</ a ></ li >< li >< a href = "../modules/_waku_utils.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > @waku/utils - v0.0.14</ a ></ li >< li >< a href = "../modules/_waku_proto.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > @waku/proto - v0.0.6</ a ></ li >< li >< a href = "../modules/_waku_enr
