mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-05-16 04:21:21 +00:00
634 lines
32 KiB
HTML
634 lines
32 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Circuit | 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/_circuit_transport_.html">circuit/transport</a>
|
|
</li>
|
|
<li>
|
|
<a href="_circuit_transport_.circuit.html">Circuit</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class Circuit</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">Circuit</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_transport_.circuit.html#circuitrequest" class="tsd-kind-icon">Circuit<wbr>Request</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#connection" class="tsd-kind-icon">Connection</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</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_transport_.circuit.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="_circuit_transport_.circuit.html#_connectionmanager" class="tsd-kind-icon">_connection<wbr>Manager</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_dialer" class="tsd-kind-icon">_dialer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_libp2p" class="tsd-kind-icon">_libp2p</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_options" class="tsd-kind-icon">_options</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_registrar" class="tsd-kind-icon">_registrar</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_upgrader" class="tsd-kind-icon">_upgrader</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#handler" class="tsd-kind-icon">handler</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Accessors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</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_transport_.circuit.html#_onprotocol" class="tsd-kind-icon">_on<wbr>Protocol</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#createlistener" class="tsd-kind-icon">create<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#dial" class="tsd-kind-icon">dial</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_circuit_transport_.circuit.html#filter" class="tsd-kind-icon">filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_circuit_transport_.circuit.html#istransport" class="tsd-kind-icon">is<wbr>Transport</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="circuitrequest" class="tsd-anchor"></a>
|
|
<h3>Circuit<wbr>Request</h3>
|
|
Re-exports <a href="../modules/_circuit_transport_.html#circuitrequest">CircuitRequest</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 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 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>
|
|
<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>Circuit<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>upgrader<span class="tsd-signature-symbol">: </span><a href="_upgrader_.upgrader.html" class="tsd-signature-type">Upgrader</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_circuit_transport_.circuit.html" class="tsd-signature-type">Circuit</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 the Circuit Transport.</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>upgrader<span class="tsd-signature-symbol">: </span><a href="_upgrader_.upgrader.html" class="tsd-signature-type">Upgrader</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>
|
|
<li class="tsd-parameter">
|
|
<h5>upgrader<span class="tsd-signature-symbol">: </span><a href="_upgrader_.upgrader.html" class="tsd-signature-type">Upgrader</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="_circuit_transport_.circuit.html" class="tsd-signature-type">Circuit</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="_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="_dialer" class="tsd-anchor"></a>
|
|
<h3>_dialer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_dialer<span class="tsd-signature-symbol">:</span> <a href="../modules/_dialer_dial_request_.html#dialer-1" class="tsd-signature-type">Dialer</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="_options" class="tsd-anchor"></a>
|
|
<h3>_options</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_options<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="_registrar" class="tsd-anchor"></a>
|
|
<h3>_registrar</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_registrar<span class="tsd-signature-symbol">:</span> <a href="_registrar_.registrar.html" class="tsd-signature-type">Registrar</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_upgrader" class="tsd-anchor"></a>
|
|
<h3>_upgrader</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_upgrader<span class="tsd-signature-symbol">:</span> <a href="_upgrader_.upgrader.html" class="tsd-signature-type">Upgrader</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="handler" class="tsd-anchor"></a>
|
|
<h3>handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></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>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Accessors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
|
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</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="_onprotocol" class="tsd-anchor"></a>
|
|
<h3>_on<wbr>Protocol</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">_on<wbr>Protocol<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>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></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>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>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>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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createlistener" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Listener<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Listener</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>Create a listener</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>handler: <span class="tsd-signature-type">Function</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Listener</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="dial" class="tsd-anchor"></a>
|
|
<h3>dial</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">dial<span class="tsd-signature-symbol">(</span>ma<span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AbortSignal</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-symbol">: </span><span class="tsd-signature-type">Promise</span><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></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>Dial a peer over a relay</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>ma: <a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the multiaddr of the peer to dial</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>dial options</p>
|
|
</div>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>signal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></h4>
|
|
<ul>
|
|
<li>the connection</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="filter" class="tsd-anchor"></a>
|
|
<h3>filter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">filter<span class="tsd-signature-symbol">(</span>multiaddrs<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><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>Filter check for all Multiaddrs that this transport can dial on</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>multiaddrs: <a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<a name="istransport" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Transport</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Transport<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Transport</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>Checks if the given value is a Transport instance.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Transport</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_transport_.html">circuit/transport</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_transport_.circuit.html" class="tsd-kind-icon">Circuit</a>
|
|
<ul>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#circuitrequest" class="tsd-kind-icon">Circuit<wbr>Request</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#connection" class="tsd-kind-icon">Connection</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_connectionmanager" class="tsd-kind-icon">_connection<wbr>Manager</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_dialer" class="tsd-kind-icon">_dialer</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_libp2p" class="tsd-kind-icon">_libp2p</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_options" class="tsd-kind-icon">_options</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_registrar" class="tsd-kind-icon">_registrar</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_upgrader" class="tsd-kind-icon">_upgrader</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#handler" class="tsd-kind-icon">handler</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#_onprotocol" class="tsd-kind-icon">_on<wbr>Protocol</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#createlistener" class="tsd-kind-icon">create<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#dial" class="tsd-kind-icon">dial</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_circuit_transport_.circuit.html#filter" class="tsd-kind-icon">filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<a href="_circuit_transport_.circuit.html#istransport" class="tsd-kind-icon">is<wbr>Transport</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_transport_.html#circuitrequest" class="tsd-kind-icon">Circuit<wbr>Request</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_circuit_transport_.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/_circuit_transport_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_circuit_transport_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</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-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> |