mirror of
https://github.com/fluencelabs/js-libp2p-tcp
synced 2025-05-15 06:01:32 +00:00
82 lines
2.2 KiB
Markdown
82 lines
2.2 KiB
Markdown
js-libp2p-tcp
|
|
===============
|
|
|
|
[](http://ipn.io)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
|
[](https://travis-ci.org/libp2p/js-libp2p-tcp)
|
|
|
|
[](https://david-dm.org/libp2p/js-libp2p-tcp)
|
|
[](https://github.com/feross/standard)
|
|
|
|
|
|
|
|
|
|
> Node.js implementation of the TCP module that libp2p uses, which implements
|
|
> the [interface-connection](https://github.com/libp2p/interface-connection)
|
|
> interface for dial/listen.
|
|
|
|
## Description
|
|
|
|
`libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a
|
|
`multiaddr`. This small shim will enable libp2p to use other different
|
|
transports.
|
|
|
|
## Example
|
|
|
|
```js
|
|
const TCP = require('libp2p-tcp')
|
|
const multiaddr = require('multiaddr')
|
|
|
|
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
|
const mh2 = multiaddr('/ip6/::/tcp/9092')
|
|
|
|
const tcp = new Tcp()
|
|
|
|
var listener = tcp.createListener(mh1, function handler (socket) {
|
|
console.log('connection')
|
|
socket.end('bye')
|
|
})
|
|
|
|
var listener.listen(function ready () {
|
|
console.log('ready')
|
|
|
|
const client = tcp.dial(mh1)
|
|
client.pipe(process.stdout)
|
|
client.on('end', () => {
|
|
tcp.close()
|
|
})
|
|
})
|
|
|
|
```
|
|
|
|
outputs
|
|
|
|
```
|
|
ready
|
|
connection
|
|
bye
|
|
```
|
|
|
|
## Installation
|
|
|
|
### npm
|
|
|
|
```sh
|
|
> npm i libp2p-tcp
|
|
```
|
|
|
|
## API
|
|
|
|
[](https://github.com/diasdavid/interface-transport)
|
|
|
|
`libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
|
|
|
|
`/ip4/127.0.0.1/tcp/4001`
|
|
`/ip4/127.0.0.1/tcp/4001/ipfs/QmHash`
|
|
|
|
Both for dialing and listening.
|
|
|
|
## License
|
|
|
|
MIT
|