All the ways for doing requests/streams multiplexing over a single stream
MIT License
Multiplexing requests and streams over a single connection since 2015.
npm i tentacoli --save
'use strict'
var tentacoli = require('./')
var net = require('net')
var from = require('from2')
var through = require('through2')
var pump = require('pump')
var server = net.createServer(function (original) {
var stream = tentacoli()
pump(stream, original, stream)
stream.on('request', handle)
})
function handle (req, reply) {
console.log('--> request is', req.cmd)
reply(null, {
data: 'some data',
streams: {
echo: req.streams.inStream.pipe(through.obj())
}
})
}
server.listen(4200, function () {
var original = net.connect(4200)
var instance = tentacoli()
pump(original, instance, original)
instance.request({
cmd: 'a request',
streams: {
inStream: from.obj(['hello', 'world'])
}
}, function (err, result) {
if (err) {
throw err
}
console.log('--> result is', result.data)
console.log('--> stream data:')
result.streams.echo.pipe(through.obj(function (chunk, enc, cb) {
cb(null, chunk + '\n')
})).pipe(process.stdout)
result.streams.echo.on('end', function () {
console.log('--> ended')
instance.destroy()
server.close()
})
})
})
Yes, it is long.
Creates a new instance of Tentacoli, which is a Duplex stream and inherits from multiplex
It accepts the following option:
codec
: an object with a encode
and decode
method, which willmaxInflight
: max number of concurrent requests inSends a request to the remote peer.
message
is a standard JS object, but all streams contained in itsstreams
property will be multiplexed and forwarded to the othercallback
will be called if an error occurred or a response isres.streams
property will contain all streamsSends a fire and forget request to the remote peer.
message
is a standard JS object, but all streams contained in itsstreams
property will be multiplexed and forwarded to the othercallback
will be called if there is an error while sending the message, or after the message has been sent successfully.The 'request'
event is emitted when there is an incoming request.
req
is the standard JS object coming from request
,streams
property will have been multiplexed and forwarded fromreply
is the function to send a reply to the other peer, and itreply(err, res).
res.streams
property should contain all the streamsYou will use websocket-stream to wire tentacoli to the websocket.
On the server:
'use strict'
var http = require('http')
var tentacoli = require('./')
var pump = require('pump')
var websocket = require('websocket-stream')
var server = http.createServer(serve)
websocket.createServer({
server: server
}, handle)
function handle (sock) {
var receiver = tentacoli()
pump(sock, receiver, sock)
receiver.on('request', function request (req, reply) {
// just echo
reply(null, req)
})
}
server.listen(3000, function (err) {
if (err) throw err
console.error('listening on', server.address().port)
})
On the client:
'use strict'
var tentacoli = require('../')
var ws = require('websocket-stream')
var pump = require('pump')
var from = require('from2')
var URL = require('url')
var serverOpts = URL.parse(document.URL)
serverOpts.path = undefined
serverOpts.pathname = undefined
serverOpts.protocol = 'ws'
var server = URL.format(serverOpts)
var stream = ws(server)
var instance = tentacoli()
pump(stream, instance, stream)
instance.request({
streams: {
inStream: from.obj(['hello', 'world'])
}
}, function (err, data) {
if (err) throw err
var res = data.streams.inStream
res.on('data', function (chunk) {
console.log(chunk)
})
})
Browserify offers a way of packaging up this module for front-end usage. You will just need to install/specify the brfs transform.
As an example:
browserify -t brfs tentacoli.js > bundle.js
WebPack offers the more popular way of packaging up node modules for browser usage. You will just need to install/specify the brfs transform.
You should install webpack, transform-loader and brfs:
npm i webpack transform-loader brfs websocket-stream --save
Then, set this as your webpack configuration:
'use strict'
module.exports = {
module: {
postLoaders: [{
loader: "transform?brfs"
}]
}
}
To build:
webpack --config webpack.config.js yourfile.js build.js
This library would not be possible without the great work of @mafintosh, @substack and @maxodgen. This library is fully based on their work, look at package.json!
Another great source of inspriation was jschan from which I borrowed a lot of ideas. Thanks Adrian Roussow for all the discussions around microservices, streams and channels.
Many thanks to @mcdonnelldean for providing an excuse to write this random idea out.
This project is kindly sponsored by nearForm.
MIT