mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-05-28 09:51:19 +00:00
628 lines
34 KiB
HTML
628 lines
34 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>AutoRelay | libp2p - v0.30.6</title>
|
|
<meta name="description" content="Documentation for libp2p - v0.30.6">
|
|
<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.6</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/_circuit_auto_relay_.html">circuit/auto-relay</a>
|
|
</li>
|
|
<li>
|
|
<a href="_circuit_auto_relay_.autorelay.html">AutoRelay</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class AutoRelay</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>{import('../')} libp2p</p>
|
|
</dd>
|
|
<dt>property</dt>
|
|
<dd><p>{number} [maxListeners = 1] - maximum number of relays to listen.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">AutoRelay</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="_circuit_auto_relay_.autorelay.html#address" class="tsd-kind-icon">Address</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#autorelayoptions" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Options</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#autorelayproperties" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Properties</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#connection" class="tsd-kind-icon">Connection</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="_circuit_auto_relay_.autorelay.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="_circuit_auto_relay_.autorelay.html#_addlistenrelay" class="tsd-kind-icon">_add<wbr>Listen<wbr>Relay</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_addresssorter" class="tsd-kind-icon">_address<wbr>Sorter</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_connectionmanager" class="tsd-kind-icon">_connection<wbr>Manager</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_libp2p" class="tsd-kind-icon">_libp2p</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_listenrelays" class="tsd-kind-icon">_listen<wbr>Relays</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_peerid" class="tsd-kind-icon">_peer<wbr>Id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_peerstore" class="tsd-kind-icon">_peer<wbr>Store</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_circuit_auto_relay_.autorelay.html#_removelistenrelay" class="tsd-kind-icon">_remove<wbr>Listen<wbr>Relay</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_transportmanager" class="tsd-kind-icon">_transport<wbr>Manager</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#maxlisteners" class="tsd-kind-icon">max<wbr>Listeners</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="_circuit_auto_relay_.autorelay.html#_listenonavailablehoprelays" class="tsd-kind-icon">_listen<wbr>OnAvailable<wbr>Hop<wbr>Relays</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_onpeerdisconnected" class="tsd-kind-icon">_on<wbr>Peer<wbr>Disconnected</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_circuit_auto_relay_.autorelay.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</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="address" class="tsd-anchor"></a>
|
|
<h3>Address</h3>
|
|
Re-exports <a href="../modules/_peer_store_address_book_.html#address">Address</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="autorelayoptions" class="tsd-anchor"></a>
|
|
<h3>Auto<wbr>Relay<wbr>Options</h3>
|
|
Re-exports <a href="../modules/_circuit_index_.html#autorelayoptions">AutoRelayOptions</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="autorelayproperties" class="tsd-anchor"></a>
|
|
<h3>Auto<wbr>Relay<wbr>Properties</h3>
|
|
Re-exports <a href="../modules/_circuit_auto_relay_.html#autorelayproperties">AutoRelayProperties</a>
|
|
</section>
|
|
<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>
|
|
<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>Auto<wbr>Relay<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>maxListeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_circuit_auto_relay_.autorelay.html" class="tsd-signature-type">AutoRelay</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>Creates an instance of AutoRelay.</p>
|
|
</div>
|
|
</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>maxListeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><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>
|
|
<li class="tsd-parameter">
|
|
<h5>max<wbr>Listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="_circuit_auto_relay_.autorelay.html" class="tsd-signature-type">AutoRelay</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="_addlistenrelay" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _add<wbr>Listen<wbr>Relay</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_add<wbr>Listen<wbr>Relay<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>Attempt to listen on the given relay connection.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd><p>connection to the peer</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>peer identifier string</p>
|
|
</dd>
|
|
<dt>returns</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_addresssorter" class="tsd-anchor"></a>
|
|
<h3>_address<wbr>Sorter</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_address<wbr>Sorter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>addresses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>addresses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>addresses: <span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>isCertified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiaddr<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-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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="_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="_listenrelays" class="tsd-anchor"></a>
|
|
<h3>_listen<wbr>Relays</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_listen<wbr>Relays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</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 class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="_removelistenrelay" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _remove<wbr>Listen<wbr>Relay</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_remove<wbr>Listen<wbr>Relay<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>Remove listen relay.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd><p>peer identifier string.</p>
|
|
</dd>
|
|
<dt>returns</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_transportmanager" class="tsd-anchor"></a>
|
|
<h3>_transport<wbr>Manager</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_transport<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="_transport_manager_.transportmanager.html" class="tsd-signature-type">TransportManager</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="maxlisteners" class="tsd-anchor"></a>
|
|
<h3>max<wbr>Listeners</h3>
|
|
<div class="tsd-signature tsd-kind-icon">max<wbr>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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="_listenonavailablehoprelays" class="tsd-anchor"></a>
|
|
<h3>_listen<wbr>OnAvailable<wbr>Hop<wbr>Relays</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">_listen<wbr>OnAvailable<wbr>Hop<wbr>Relays<span class="tsd-signature-symbol">(</span>peersToIgnore<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-type">undefined</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></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>Try to listen on available hop relay connections.
|
|
The following order will happen while we do not have enough relays.</p>
|
|
<ol>
|
|
<li>Check the metadata store for known relays, try to listen on the ones we are already connected.</li>
|
|
<li>Dial and try to listen on the peers we know that support hop but are not connected.</li>
|
|
<li>Search the network.</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> peersToIgnore: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="_onpeerdisconnected" class="tsd-anchor"></a>
|
|
<h3>_on<wbr>Peer<wbr>Disconnected</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">_on<wbr>Peer<wbr>Disconnected<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">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>Peer disconnects.</p>
|
|
</div>
|
|
</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>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>connection to the peer</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<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">
|
|
<a name="_onprotocolchange" class="tsd-anchor"></a>
|
|
<h3>_on<wbr>Protocol<wbr>Change</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">_on<wbr>Protocol<wbr>Change<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>protocols<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><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>Check if a peer supports the relay protocol.
|
|
If the protocol is not supported, check if it was supported before and remove it as a listen relay.
|
|
If the protocol is supported, check if the peer supports <strong>HOP</strong> and add it as a listener if
|
|
inside the threshold.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>protocols<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>peer<wbr>Id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>protocols<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 <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>
|
|
</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/_circuit_auto_relay_.html">circuit/auto-relay</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="_circuit_auto_relay_.autorelay.html" class="tsd-kind-icon">Auto<wbr>Relay</a>
|
|
<ul>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#address" class="tsd-kind-icon">Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#autorelayoptions" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#autorelayproperties" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Properties</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#connection" class="tsd-kind-icon">Connection</a>
|
|
</li>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_addlistenrelay" class="tsd-kind-icon">_add<wbr>Listen<wbr>Relay</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_addresssorter" class="tsd-kind-icon">_address<wbr>Sorter</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_connectionmanager" class="tsd-kind-icon">_connection<wbr>Manager</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_libp2p" class="tsd-kind-icon">_libp2p</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_listenrelays" class="tsd-kind-icon">_listen<wbr>Relays</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_peerid" class="tsd-kind-icon">_peer<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_peerstore" class="tsd-kind-icon">_peer<wbr>Store</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_removelistenrelay" class="tsd-kind-icon">_remove<wbr>Listen<wbr>Relay</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_transportmanager" class="tsd-kind-icon">_transport<wbr>Manager</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#maxlisteners" class="tsd-kind-icon">max<wbr>Listeners</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_listenonavailablehoprelays" class="tsd-kind-icon">_listen<wbr>OnAvailable<wbr>Hop<wbr>Relays</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_onpeerdisconnected" class="tsd-kind-icon">_on<wbr>Peer<wbr>Disconnected</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_auto_relay_.autorelay.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</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/_circuit_auto_relay_.html#address" class="tsd-kind-icon">Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_circuit_auto_relay_.html#autorelayoptions" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_circuit_auto_relay_.html#autorelayproperties" class="tsd-kind-icon">Auto<wbr>Relay<wbr>Properties</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_circuit_auto_relay_.html#connection" class="tsd-kind-icon">Connection</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-interface"><span class="tsd-kind-icon">Interface</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>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |