mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-05-28 18:01:19 +00:00
619 lines
31 KiB
HTML
619 lines
31 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>IdentifyService | libp2p - v0.30.0-rc.1</title>
|
|
<meta name="description" content="Documentation for libp2p - v0.30.0-rc.1">
|
|
<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>
|
|
<a href="../index.html" class="title">libp2p - v0.30.0-rc.1</a>
|
|
</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/_identify_index_.html">identify/index</a>
|
|
</li>
|
|
<li>
|
|
<a href="_identify_index_.identifyservice.html">IdentifyService</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class IdentifyService</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">
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">IdentifyService</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="_identify_index_.identifyservice.html#connection" class="tsd-kind-icon">Connection</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#messsage" class="tsd-kind-icon">Messsage</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#multicodecs" class="tsd-kind-icon">multicodecs</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="_identify_index_.identifyservice.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 tsd-is-private"><a href="_identify_index_.identifyservice.html#_handleidentify" class="tsd-kind-icon">_handle<wbr>Identify</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_identify_index_.identifyservice.html#_handlepush" class="tsd-kind-icon">_handle<wbr>Push</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#_host" class="tsd-kind-icon">_host</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#_libp2p" class="tsd-kind-icon">_libp2p</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</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="_identify_index_.identifyservice.html#handlemessage" class="tsd-kind-icon">handle<wbr>Message</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#identify" class="tsd-kind-icon">identify</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#push" class="tsd-kind-icon">push</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_identify_index_.identifyservice.html#pushtopeerstore" class="tsd-kind-icon">push<wbr>ToPeer<wbr>Store</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_identify_index_.identifyservice.html#getcleanmultiaddr" class="tsd-kind-icon">get<wbr>Clean<wbr>Multiaddr</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="connection" class="tsd-anchor"></a>
|
|
<h3>Connection</h3>
|
|
Re-exports <a href="../modules/_connection_manager_index_.html#connection">Connection</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="messsage" class="tsd-anchor"></a>
|
|
<h3>Messsage</h3>
|
|
Renames and exports <a href="../modules/_identify_index_.html#message">Message</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="muxedstream" class="tsd-anchor"></a>
|
|
<h3>Muxed<wbr>Stream</h3>
|
|
Re-exports <a href="../modules/_upgrader_.html#muxedstream">MuxedStream</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="multicodecs" class="tsd-anchor"></a>
|
|
<h3>multicodecs</h3>
|
|
Re-exports <a href="../modules/_identify_index_.multicodecs.html">multicodecs</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>Identify<wbr>Service<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>libp2p<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_identify_index_.identifyservice.html" class="tsd-signature-type">IdentifyService</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>libp2p<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>libp2p<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="_identify_index_.identifyservice.html" class="tsd-signature-type">IdentifyService</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 tsd-is-private">
|
|
<a name="_handleidentify" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _handle<wbr>Identify</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_handle<wbr>Identify<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Sends the <code>Identify</code> response with the Signed Peer Record
|
|
to the requesting peer over the given <code>connection</code></p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>returns</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="_handlepush" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _handle<wbr>Push</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_handle<wbr>Push<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Reads the Identify Push message from the given <code>connection</code></p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>param</dt>
|
|
<dd></dd>
|
|
<dt>returns</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_host" class="tsd-anchor"></a>
|
|
<h3>_host</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_libp2p" class="tsd-anchor"></a>
|
|
<h3>_libp2p</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_libp2p<span class="tsd-signature-symbol">:</span> <a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="connectionmanager" class="tsd-anchor"></a>
|
|
<h3>connection<wbr>Manager</h3>
|
|
<div class="tsd-signature tsd-kind-icon">connection<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="_connection_manager_index_.connectionmanager.html" class="tsd-signature-type">ConnectionManager</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="peerid" class="tsd-anchor"></a>
|
|
<h3>peer<wbr>Id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="peerstore" class="tsd-anchor"></a>
|
|
<h3>peer<wbr>Store</h3>
|
|
<div class="tsd-signature tsd-kind-icon">peer<wbr>Store<span class="tsd-signature-symbol">:</span> <a href="../modules/_peer_store_book_.html#peerstore" class="tsd-signature-type">PeerStore</a></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="handlemessage" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Message</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Message<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>connection<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MuxedStream</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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>A handler to register with Libp2p to process identify messages.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>connection<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MuxedStream</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>connection<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MuxedStream</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="identify" class="tsd-anchor"></a>
|
|
<h3>identify</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">identify<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><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></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>Requests the <code>Identify</code> message from peer associated with the given <code>connection</code>.
|
|
If the identified peer does not match the <code>PeerId</code> associated with the connection,
|
|
an error will be thrown.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>async</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>connection: <a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a></h5>
|
|
</li>
|
|
</ul>
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="push" class="tsd-anchor"></a>
|
|
<h3>push</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>connections<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><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><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>Send an Identify Push update to the list of connections</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>connections: <a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<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><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="pushtopeerstore" class="tsd-anchor"></a>
|
|
<h3>push<wbr>ToPeer<wbr>Store</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">push<wbr>ToPeer<wbr>Store<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></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>Calls <code>push</code> for all peers in the <code>peerStore</code> that are connected</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<a name="getcleanmultiaddr" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Clean<wbr>Multiaddr</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Clean<wbr>Multiaddr<span class="tsd-signature-symbol">(</span>addr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</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="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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>Takes the <code>addr</code> and converts it to a Multiaddr if possible</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addr: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<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><span class="tsd-signature-type">null</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/_identify_index_.html">identify/index</a>
|
|
<ul>
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_identify_index_.multicodecs.html">multicodecs</a>
|
|
</li>
|
|
</ul>
|
|
</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="_identify_index_.identifyservice.html" class="tsd-kind-icon">Identify<wbr>Service</a>
|
|
<ul>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#connection" class="tsd-kind-icon">Connection</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#messsage" class="tsd-kind-icon">Messsage</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#multicodecs" class="tsd-kind-icon">multicodecs</a>
|
|
</li>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="_identify_index_.identifyservice.html#_handleidentify" class="tsd-kind-icon">_handle<wbr>Identify</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="_identify_index_.identifyservice.html#_handlepush" class="tsd-kind-icon">_handle<wbr>Push</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#_host" class="tsd-kind-icon">_host</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#_libp2p" class="tsd-kind-icon">_libp2p</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#handlemessage" class="tsd-kind-icon">handle<wbr>Message</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#identify" class="tsd-kind-icon">identify</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#push" class="tsd-kind-icon">push</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_identify_index_.identifyservice.html#pushtopeerstore" class="tsd-kind-icon">push<wbr>ToPeer<wbr>Store</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<a href="_identify_index_.identifyservice.html#getcleanmultiaddr" class="tsd-kind-icon">get<wbr>Clean<wbr>Multiaddr</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/_identify_index_.html#connection" class="tsd-kind-icon">Connection</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_identify_index_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_identify_index_.html#multicodec_identify" class="tsd-kind-icon">MULTICODEC_<wbr>IDENTIFY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_identify_index_.html#multicodec_identify_push" class="tsd-kind-icon">MULTICODEC_<wbr>IDENTIFY_<wbr>PUSH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_identify_index_.html#message" class="tsd-kind-icon">Message</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>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |