websocket-framed

WebSocket-Framed

Framed WebSocket Communication for Node.js and Browser.

About

This is a small JavaScript librar< for Node.js and the Browser to encode/decode WebSocket messages to/from frames, based on the object serialization formats JavaScript Object Notation (JSON, RFC4627), Concise Binary Object Representation (CBOR, RFC7049) or MsgPack. It solves three particular problems: the serialization of the data, the type annotation of data and the request/response correlation.

Installation

$ npm install websocket-framed

Usage

const WebSocketFramed = require("websocket-framed")

let ws  = new WebSocket(...)
let wsf = new WebSocketFramed(ws, "cbor")

wsf.on("message", (event) => {
    let request = event.frame
    let { fid, rid, type, message }) = request
    let response = { type: ..., message: ... }
    wsf.send(response, request)
})

let request = { type: ..., data: ... }
wsf.send(request)

Application Programming Interface

• new WebSocketFramed(ws: WebSocket, codec: string = "json"): API Create a new WebSocket-Framed instance for a particular communication with the help of the frame serialization cocdec. The supported codecs are json, cbor and msgpack.

• API::on(name: string, callback: (event: { frame: { fid: number, rid: number, type: string, data: string }, data: any }) => Void): Void Receive a message in case name is message in the form of a decoded frame attached to event.frame.

• API::send(frame: { type: string, data: string }, replyTo?: frame): { frame: { fid: number, rid: number, type: string, data: string }, data: any } Send a message in the form of a encoded frame. Optionally set the rid of the message to the fid of the frame you want to reply to.

License

Copyright (c) 2017 Ralf S. Engelschall (http://engelschall.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.