js-libp2p/classes/_address_manager_index_.addressmanager.html

402 lines
18 KiB
HTML
Raw Normal View History

2020-12-10 15:50:24 +01:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
2020-12-11 18:28:40 +01:00
<title>AddressManager | libp2p - v0.30.0-rc.1</title>
<meta name="description" content="Documentation for libp2p - v0.30.0-rc.1">
2020-12-10 15:50:24 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
<style>
.toolbar-icon {
display: inline-block;
vertical-align: middle;
margin-left: 10px;
cursor: pointer;
}
.toolbar-icon-search {
box-sizing: border-box;
position: absolute;
overflow: hidden;
right: -40px;
width: 40px;
height: 40px;
display: flex;
justify-content: center;
align-items: center;
@media (min-width: 901px){
display: none
}
}
@media (min-width: 901px){
.toolbar-icon-menu {
display: none
}
.toolbar-icon-options {
display: none
}
}
.gg-menu {
transform: scale(var(--ggs,1))
}
.gg-menu,
.gg-menu::after,
.gg-menu::before {
box-sizing: border-box;
position: relative;
display: block;
width: 20px;
height: 2px;
border-radius: 3px;
background: currentColor
}
.gg-menu::after,
.gg-menu::before {
content: "";
position: absolute;
top: -6px
}
.gg-menu::after {
top: 6px
}
.gg-options {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 10px;
height: 2px;
box-shadow:
-3px 4px 0 0,
3px -4px 0 0
}
.gg-options::after,
.gg-options::before {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
width: 8px;
height: 8px;
border: 2px solid;
border-radius: 100%
}
.gg-options::before {
top: -7px;
left: -4px
}
.gg-options::after {
bottom: -7px;
right: -4px
}
.gg-search {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 16px;
height: 16px;
border: 2px solid;
border-radius: 100%;
margin-left: -4px;
margin-top: -4px
}
.gg-search::after {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
border-radius: 3px;
width: 2px;
height: 8px;
background: currentColor;
transform: rotate(-45deg);
top: 10px;
left: 12px
}
</style>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
2020-12-11 18:28:40 +01:00
<a href="../index.html" class="title">libp2p - v0.30.0-rc.1</a>
2020-12-10 15:50:24 +01:00
</div>
<div class="table-cell" id="tsd-widgets">
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules/_address_manager_index_.html">address-manager/index</a>
</li>
<li>
<a href="_address_manager_index_.addressmanager.html">AddressManager</a>
</li>
</ul>
<h1>Class AddressManager</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>property</dt>
<dd><p>{string[]} [listen = []] - list of multiaddrs string representation to listen.</p>
</dd>
<dt>property</dt>
<dd><p>{string[]} [announce = []] - list of multiaddrs string representation to announce.</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AddressManager</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>References</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#addressmanageroptions" class="tsd-kind-icon">Address<wbr>Manager<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#announce" class="tsd-kind-icon">announce</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#listen" class="tsd-kind-icon">listen</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#getannounceaddrs" class="tsd-kind-icon">get<wbr>Announce<wbr>Addrs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_address_manager_index_.addressmanager.html#getlistenaddrs" class="tsd-kind-icon">get<wbr>Listen<wbr>Addrs</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>References</h2>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="addressmanageroptions" class="tsd-anchor"></a>
<h3>Address<wbr>Manager<wbr>Options</h3>
Re-exports <a href="../modules/_address_manager_index_.html#addressmanageroptions">AddressManagerOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="multiaddr" class="tsd-anchor"></a>
<h3>Multiaddr</h3>
Re-exports <a href="../modules/_address_manager_index_.html#multiaddr">Multiaddr</a>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Address<wbr>Manager<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>announce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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>listen<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_address_manager_index_.addressmanager.html" class="tsd-signature-type">AddressManager</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Responsible for managing the peer addresses.
Peers can specify their listen and announce addresses.
The listen addresses will be used by the libp2p transports to listen for new connections,
while the announce addresses will be used for the peer addresses&#39; to other peers in the network.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> __namedParameters: <span class="tsd-signature-symbol">{ </span>announce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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>listen<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>announce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>listen<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_address_manager_index_.addressmanager.html" class="tsd-signature-type">AddressManager</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="announce" class="tsd-anchor"></a>
<h3>announce</h3>
<div class="tsd-signature tsd-kind-icon">announce<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="listen" class="tsd-anchor"></a>
<h3>listen</h3>
<div class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getannounceaddrs" class="tsd-anchor"></a>
<h3>get<wbr>Announce<wbr>Addrs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Announce<wbr>Addrs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get peer announcing multiaddrs.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlistenaddrs" class="tsd-anchor"></a>
<h3>get<wbr>Listen<wbr>Addrs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Listen<wbr>Addrs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get peer listen multiaddrs.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current tsd-kind-module">
<a href="../modules/_address_manager_index_.html">address-manager/index</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_address_manager_index_.addressmanager.html" class="tsd-kind-icon">Address<wbr>Manager</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#addressmanageroptions" class="tsd-kind-icon">Address<wbr>Manager<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#announce" class="tsd-kind-icon">announce</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#listen" class="tsd-kind-icon">listen</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#getannounceaddrs" class="tsd-kind-icon">get<wbr>Announce<wbr>Addrs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_address_manager_index_.addressmanager.html#getlistenaddrs" class="tsd-kind-icon">get<wbr>Listen<wbr>Addrs</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_address_manager_index_.html#addressmanageroptions" class="tsd-kind-icon">Address<wbr>Manager<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>