mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-04-24 18:02:28 +00:00
912 lines
59 KiB
HTML
912 lines
59 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Connection | libp2p-interfaces - v0.8.4</title>
|
|
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
|
<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-interfaces - v0.8.4</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/_connection_connection_.html">connection/connection</a>
|
|
</li>
|
|
<li>
|
|
<a href="_connection_connection_.connection.html">Connection</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class Connection</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 class="lead">
|
|
<p>An implementation of the js-libp2p connection.
|
|
Any libp2p transport should use an upgrader to return this connection.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">Connection</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="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</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="_connection_connection_.connection.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="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</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="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</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="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</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="conectionstat" class="tsd-anchor"></a>
|
|
<h3>Conection<wbr>Stat</h3>
|
|
Re-exports <a href="../modules/_connection_connection_.html#conectionstat">ConectionStat</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="connectionoptions" class="tsd-anchor"></a>
|
|
<h3>Connection<wbr>Options</h3>
|
|
Re-exports <a href="../modules/_connection_connection_.html#connectionoptions">ConnectionOptions</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/_connection_connection_.html#muxedstream">MuxedStream</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="status" class="tsd-anchor"></a>
|
|
<h3>Status</h3>
|
|
Re-exports <a href="../modules/_connection_connection_.html#status">Status</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="streamdata" class="tsd-anchor"></a>
|
|
<h3>Stream<wbr>Data</h3>
|
|
Re-exports <a href="../modules/_connection_connection_.html#streamdata">StreamData</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
|
<a name="timeline" class="tsd-anchor"></a>
|
|
<h3>Timeline</h3>
|
|
Re-exports <a href="../modules/_connection_connection_.html#timeline-1">Timeline</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>Connection<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>close<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><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</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>An implementation of the js-libp2p connection.
|
|
Any libp2p transport should use an upgrader to return this connection.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>close<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><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>close<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></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
|
<li class="tsd-signature tsd-kind-icon"><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">
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>get<wbr>Streams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>local<wbr>Addr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>local<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>new<wbr>Stream<span class="tsd-signature-symbol">: </span><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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
|
<li class="tsd-signature tsd-kind-icon"><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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</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>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><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-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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>remote<wbr>Addr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>remote<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</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="_close" class="tsd-anchor"></a>
|
|
<h3>_close</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_close<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></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Reference to the close function of the raw connection</p>
|
|
</div>
|
|
</div>
|
|
<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><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">
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="_closing" class="tsd-anchor"></a>
|
|
<h3>_closing</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_closing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</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="_getstreams" class="tsd-anchor"></a>
|
|
<h3>_get<wbr>Streams</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_get<wbr>Streams<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Reference to the getStreams function of the muxer</p>
|
|
</div>
|
|
</div>
|
|
<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><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="_newstream" class="tsd-anchor"></a>
|
|
<h3>_new<wbr>Stream</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_new<wbr>Stream<span class="tsd-signature-symbol">:</span> <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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Reference to the new stream function of the multiplexer</p>
|
|
</div>
|
|
</div>
|
|
<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>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</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>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><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-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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</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="_stat" class="tsd-anchor"></a>
|
|
<h3>_stat</h3>
|
|
<div class="tsd-signature tsd-kind-icon">_stat<span class="tsd-signature-symbol">:</span> <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Connection metadata.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="id" class="tsd-anchor"></a>
|
|
<h3>id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Connection identifier.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="localaddr" class="tsd-anchor"></a>
|
|
<h3>local<wbr>Addr</h3>
|
|
<div class="tsd-signature tsd-kind-icon">local<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Observed multiaddr of the local peer</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="localpeer" class="tsd-anchor"></a>
|
|
<h3>local<wbr>Peer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">local<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Local peer id.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="registry" class="tsd-anchor"></a>
|
|
<h3>registry</h3>
|
|
<div class="tsd-signature tsd-kind-icon">registry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Connection streams registry</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="remoteaddr" class="tsd-anchor"></a>
|
|
<h3>remote<wbr>Addr</h3>
|
|
<div class="tsd-signature tsd-kind-icon">remote<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Observed multiaddr of the remote peer</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="remotepeer" class="tsd-anchor"></a>
|
|
<h3>remote<wbr>Peer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">remote<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Remote peer id.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="tags" class="tsd-anchor"></a>
|
|
<h3>tags</h3>
|
|
<div class="tsd-signature tsd-kind-icon">tags<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 class="lead">
|
|
<p>User provided tags</p>
|
|
</div>
|
|
</div>
|
|
</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 class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="stat" class="tsd-anchor"></a>
|
|
<h3>stat</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> stat<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get connection metadata</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="streams" class="tsd-anchor"></a>
|
|
<h3>streams</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> streams<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get all the streams of the muxer.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</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="addstream" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Stream<span class="tsd-signature-symbol">(</span>muxedStream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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><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>Add a stream when it is opened to the registry.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>muxedStream: <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a muxed stream</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</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="close" class="tsd-anchor"></a>
|
|
<h3>close</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">close<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>Close the connection.</p>
|
|
</div>
|
|
</div>
|
|
<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="newstream" class="tsd-anchor"></a>
|
|
<h3>new<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new<wbr>Stream<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-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-type">Promise</span><span class="tsd-signature-symbol"><</span><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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><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>Create a new stream from this connection</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>intended protocol for the stream</p>
|
|
</div>
|
|
</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-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><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
<blockquote>
|
|
<p>} with muxed+multistream-selected stream and selected protocol</p>
|
|
</blockquote>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="removestream" class="tsd-anchor"></a>
|
|
<h3>remove<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">remove<wbr>Stream<span class="tsd-signature-symbol">(</span>id<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">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>Remove stream registry after it is closed.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>identifier of the stream</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 tsd-is-static">
|
|
<a name="isconnection" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Connection</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Connection<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">Connection</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 <code>Connection</code> 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">Connection</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/_connection_connection_.html">connection/connection</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="_connection_connection_.connection.html" class="tsd-kind-icon">Connection</a>
|
|
<ul>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
<a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</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/_connection_connection_.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_connection_connection_.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_connection_connection_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_connection_connection_.html#status" class="tsd-kind-icon">Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_connection_connection_.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
|
<a href="../modules/_connection_connection_.html#timeline-1" class="tsd-kind-icon">Timeline</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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</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-class"><span class="tsd-kind-icon">Class</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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</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> |