line-socket

line
=====


line is a lightweight and efficient (web)-socket library that bears non-blocking interface and scalable architecture. line is fast, reliable and yet it supports message responses, response timeouts and client rooms. line internally monitors connection health, and it pro-actively strives to achieve a stable connection. We built line on top of the javascript based ws.

With ws 8.0.0 it is possible install bufferutil as a peer dependancy to improve performance. This is a native component, and optional. If you wish to use, install it via npm in your package

``
npm i -s bufferutil
`

line runs on Node.JS and all modern browsers through an identical API. Therefore, it is a good candidate for cross-platform applications.

Key Features
------------
- Automated tests with significant code coverage
- Cross platform: Works on MacOS, Linux, Windows and browsers
- Developed in ES6 with Webpack, therefore we have a minified bundles that work nearly every platform without hassle
- Apart from uWebSockets, we support message responses, request timeouts, handshaking and client rooms
- Easy configuring: Configurations are asserted on server side and pushed to clients at handshake. No need to do configurations at the client side.
- Promise based API


----------

Installation
--------
Using npm
`sh
npm install line-socket --save
`


Usage
-------------

$3


`js
const Server = require('line-socket/server');
const server = new Server({port: 3000});

server.on('connection', function(connection) {
console.log('A client connected');

connection.on('hello', (message) => {
console.log('Received a hello messge', message.payload); // => {name: 'some client'}

setTimeout(() => {
message.resolve({hello: 'yourself'});
}, 2000)
});
})


server
.start() // Start listening port 3000
.then(() => {
console.log('Server started');
})
.catch((err) => {
console.log(Server could not started, err);
});
`




$3


`js
const LineClient = require('line-socket/client-node');
const client = new LineClient('ws://localhost:3000');

client.on('_connected', () => {
console.log('Connected to server');

client
.send('hello', {name: 'some client'})
.then((data) => {
console.log('Greeting completed', data); // => {hello: 'yourself'}
})
.catch((err) => {
// Message could not sent OR
// Message response timeout OR
// Server rejects the message
});
});

client.connect();
`




$3


We provide client constructor as LineClient global reference. In order to run line client on browser, you must include the browser bundle into your HTML file as below and then use it by creating an instance from LineClient class.
`

`

`js
const client = new LineClient('ws://localhost:3000');

/ The rest is identical to the NodeJS example /

``

Documentation
---------------

Extended documentation can be found here.

-----------
License
------------

line by SignAlive is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.