2018-01-12 12:30:57 +00:00
<!doctype html>
2019-12-06 10:09:15 +01:00
< html lang = "en" >
2019-08-08 13:27:12 +02:00
< head >
< meta charset = 'utf-8' >
2020-12-28 09:54:30 +00:00
< title > libp2p-tcp 0.15.2 | Documentation< / title >
2019-08-08 13:27:12 +02:00
< meta name = 'description' content = 'Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces' >
< meta name = 'viewport' content = 'width=device-width,initial-scale=1' >
< link href = 'assets/bass.css' rel = 'stylesheet' >
< link href = 'assets/style.css' rel = 'stylesheet' >
< link href = 'assets/github.css' rel = 'stylesheet' >
< link href = 'assets/split.css' rel = 'stylesheet' >
< / head >
< body class = 'documentation m0' >
< div class = 'flex' >
< div id = 'split-left' class = 'overflow-auto fs0 height-viewport-100' >
< div class = 'py1 px2' >
< h3 class = 'mb0 no-anchor' > libp2p-tcp< / h3 >
2020-12-28 09:54:30 +00:00
< div class = 'mb1' > < code > 0.15.2< / code > < / div >
2019-08-08 13:27:12 +02:00
< input
placeholder='Filter'
id='filter-input'
class='col12 block input'
2020-04-28 14:46:12 +02:00
spellcheck='false'
autocapitalize='off'
autocorrect='off'
2019-08-08 13:27:12 +02:00
type='text' />
< div id = 'toc' >
< ul class = 'list-reset h5 py1-ul' >
2019-12-06 10:09:15 +01:00
< li > < a
href='#tcp'
class=" toggle-sibling">
TCP
< span class = 'icon' > ▸< / span >
< / a >
< div class = 'toggle-target display-none' >
< ul class = 'list-reset py1-ul pl1' >
< li class = 'h5' > < span > Instance members< / span > < / li >
< li > < a
href='#tcpdial'
class='regular pre-open'>
#dial
< / a > < / li >
< li > < a
href='#tcpcreatelistener'
class='regular pre-open'>
#createListener
< / a > < / li >
< li > < a
href='#tcpfilter'
class='regular pre-open'>
#filter
< / a > < / li >
< / ul >
< / div >
< / li >
2019-08-08 13:27:12 +02:00
< / ul >
< / div >
< div class = 'mt1 h6 quiet' >
< a href = 'https://documentation.js.org/reading-documentation.html' > Need help reading this?< / a >
< / div >
< / div >
< / div >
< div id = 'split-right' class = 'relative overflow-auto height-viewport-100' >
2019-12-06 10:09:15 +01:00
< section class = 'p2 mb2 clearfix bg-white minishadow' >
< div class = 'clearfix' >
< h3 class = 'fl m0' id = 'tcp' >
TCP
< / h3 >
2020-12-28 09:54:30 +00:00
< a class = 'fr fill-darken0 round round pad1x quiet h5' href = 'https://github.com/libp2p/js-libp2p-tcp/blob/8661c09b6903837d42d690beca9ea5b71fdb66f7/src/index.js#L17-L139' >
2019-12-06 10:09:15 +01:00
< span > src/index.js< / span >
< / a >
< / div >
< div class = 'pre p1 fill-light mt0' > new TCP()< / div >
2020-04-28 14:46:12 +02:00
2019-12-06 10:09:15 +01:00
< div class = 'py1 quiet mt1 prose-big' > Instance Members< / div >
< div class = "clearfix" >
< div class = 'border-bottom' id = 'tcpdial' >
< div class = "clearfix small pointer toggle-sibling" >
< div class = "py1 contain" >
< a class = 'icon pin-right py1 dark-link caret-right' > ▸< / a >
< span class = 'code strong strong truncate' > dial(ma, options)< / span >
< / div >
< / div >
< div class = "clearfix display-none toggle-target" >
< section class = 'p2 mb2 clearfix bg-white minishadow' >
< div class = 'clearfix' >
2020-12-28 09:54:30 +00:00
< a class = 'fr fill-darken0 round round pad1x quiet h5' href = 'https://github.com/libp2p/js-libp2p-tcp/blob/8661c09b6903837d42d690beca9ea5b71fdb66f7/src/index.js#L37-L45' >
2019-12-06 10:09:15 +01:00
< span > src/index.js< / span >
< / a >
< / div >
< div class = 'pre p1 fill-light mt0' > dial(ma: Multiaddr, options: < a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" > object< / a > ): Connection< / div >
< div class = 'py1 quiet mt1 prose-big' > Parameters< / div >
< div class = 'prose' >
< div class = 'space-bottom0' >
< div >
< span class = 'code bold' > ma< / span > < code class = 'quiet' > (Multiaddr)< / code >
< / div >
< / div >
< div class = 'space-bottom0' >
< div >
< span class = 'code bold' > options< / span > < code class = 'quiet' > (< a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" > object< / a > )< / code >
< / div >
< table class = 'mt1 mb2 fixed-table h5 col-12' >
< colgroup >
< col width = '30%' / >
< col width = '70%' / >
< / colgroup >
< thead >
< tr class = 'bold fill-light' >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody class = 'mt1' >
< tr >
< td class = 'break-word' > < span class = 'code bold' > options.signal< / span > < code class = 'quiet' > AbortSignal< / code >
< / td >
< td class = 'break-word' > < span > Used to abort dial requests
< / span > < / td >
< / tr >
< / tbody >
< / table >
< / div >
< / div >
< div class = 'py1 quiet mt1 prose-big' > Returns< / div >
< code > Connection< / code > :
An upgraded Connection
2020-04-28 14:46:12 +02:00
2019-12-06 10:09:15 +01:00
< / section >
< / div >
< / div >
< div class = 'border-bottom' id = 'tcpcreatelistener' >
< div class = "clearfix small pointer toggle-sibling" >
< div class = "py1 contain" >
< a class = 'icon pin-right py1 dark-link caret-right' > ▸< / a >
< span class = 'code strong strong truncate' > createListener(options?, handler)< / span >
< / div >
< / div >
< div class = "clearfix display-none toggle-target" >
< section class = 'p2 mb2 clearfix bg-white minishadow' >
< div class = 'clearfix' >
2020-12-28 09:54:30 +00:00
< a class = 'fr fill-darken0 round round pad1x quiet h5' href = 'https://github.com/libp2p/js-libp2p-tcp/blob/8661c09b6903837d42d690beca9ea5b71fdb66f7/src/index.js#L114-L121' >
2019-12-06 10:09:15 +01:00
< span > src/index.js< / span >
< / a >
< / div >
< p > Creates a TCP listener. The provided < code > handler< / code > function will be called
anytime a new incoming Connection has been successfully upgraded via
< code > upgrader.upgradeInbound< / code > .< / p >
< div class = 'pre p1 fill-light mt0' > createListener(options: any?, handler: function (Connection)): Listener< / div >
< div class = 'py1 quiet mt1 prose-big' > Parameters< / div >
< div class = 'prose' >
< div class = 'space-bottom0' >
< div >
< span class = 'code bold' > options< / span > < code class = 'quiet' > (any?)< / code >
< / div >
< / div >
< div class = 'space-bottom0' >
< div >
< span class = 'code bold' > handler< / span > < code class = 'quiet' > (function (Connection))< / code >
< / div >
< / div >
< / div >
< div class = 'py1 quiet mt1 prose-big' > Returns< / div >
< code > Listener< / code > :
A TCP listener
2020-04-28 14:46:12 +02:00
2019-12-06 10:09:15 +01:00
< / section >
< / div >
< / div >
< div class = 'border-bottom' id = 'tcpfilter' >
< div class = "clearfix small pointer toggle-sibling" >
< div class = "py1 contain" >
< a class = 'icon pin-right py1 dark-link caret-right' > ▸< / a >
< span class = 'code strong strong truncate' > filter(multiaddrs)< / span >
< / div >
< / div >
< div class = "clearfix display-none toggle-target" >
< section class = 'p2 mb2 clearfix bg-white minishadow' >
< div class = 'clearfix' >
2020-12-28 09:54:30 +00:00
< a class = 'fr fill-darken0 round round pad1x quiet h5' href = 'https://github.com/libp2p/js-libp2p-tcp/blob/8661c09b6903837d42d690beca9ea5b71fdb66f7/src/index.js#L128-L138' >
2019-12-06 10:09:15 +01:00
< span > src/index.js< / span >
< / a >
< / div >
< p > Takes a list of < code > Multiaddr< / code > s and returns only valid TCP addresses< / p >
< div class = 'pre p1 fill-light mt0' > filter(multiaddrs: < a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" > Array< / a > < Multiaddr>): < a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" > Array< / a > < Multiaddr>< / div >
< div class = 'py1 quiet mt1 prose-big' > Parameters< / div >
< div class = 'prose' >
< div class = 'space-bottom0' >
< div >
< span class = 'code bold' > multiaddrs< / span > < code class = 'quiet' > (< a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" > Array< / a > < Multiaddr>)< / code >
< / div >
< / div >
< / div >
< div class = 'py1 quiet mt1 prose-big' > Returns< / div >
< code > < a href = "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" > Array< / a > < Multiaddr>< / code > :
Valid TCP multiaddrs
2020-04-28 14:46:12 +02:00
2019-12-06 10:09:15 +01:00
< / section >
< / div >
< / div >
< / div >
< / section >
2019-08-08 13:27:12 +02:00
< / div >
< / div >
< script src = 'assets/anchor.js' > < / script >
< script src = 'assets/split.js' > < / script >
< script src = 'assets/site.js' > < / script >
< / body >
< / html >
