Ws-stream-tunnel NPM

ws-stream-tunnel

For node.js

use node.js stream over websocket.

Install

npm i ws-stream-tunnel --save

Usage

Create a server,then use client to connect it. The client will negotiate with server about the tunnel type.(Both sides can create streams in the tunnel) Then the tunnel will be used to transfer stream.

websocket connection
|_one of the tunnel types
   |_stream(s)
      |_data

const {server,client}=require('ws-stream-tunnel');

//server
const tServer=new server({
	port:80,
	perMessageDeflate:false,
});
tServer.on('tunnel_open',t=>{
	console.log('server','new tunnel');

	t.on('stream_open',stream=>{
		console.log('server','stream opened');
		
		//do sth with the stream
		stream.on('data',chunk=>{
			console.log('server','recevied data',chunk)
		});

	}).once('close',()=>{
		console.log('server','tunnel closed')
	})
});


//client
const tClient=new client({
	addr:'ws://127.0.0.1:80',
	mode:'subStream',
});
tClient.on('tunnel_open',tunnel=>{
	console.log('client','tunnel opened');

	tunnel.on('stream_open',stream=>{
		console.log('client','stream opened')
		
		//do sth with the stream
		stream.write('poi');

	}).on('stream_close',stream=>{
		console.log('client','stream closed')
	}).on('error',e=>{
		console.error('client:error',e)
	}).once('close',()=>{
		console.log('client','tunnel closed')
	});

	tunnel.createStream();//create a sub stream
});

Tunnel types

subStream : mix multi-streams in one tunnel
stream : extends from subStream,but only allows one stream in the tunnel

server

Class : tunnelServer(options)

The server class extends from ws.server,options is the same with here.

Two new event

'tunnel_open' : (new tunnel)
'tunnel_close' : (the closed tunnel)

One more property

tunnelHelper : see tunnelHelper below

client

The server class extends from events.

Class : tunnelClient(options)

options

mode : tunnel type
addr : target ws address
ws : options object for ws connection,see here
idleTimeout : millisecond before closing the connection,0 presents always keep the connection,defaults to 0
keepBrokenTunnel : millisecond before closing the broken tunnel. The tunnel will immediately close if this option is not set

events