Skip to content

README.md

Latest commit

 

History

History
36 lines (30 loc) · 998 Bytes

README.md

File metadata and controls

36 lines (30 loc) · 998 Bytes
Raw

socketServerMq

Overview

A light-weight, performant websocket server supporting N-many subscribable message channels based on unique, client provided, subscription keys.

###What is it

  • socketServerMq is a wrapper for channelMq
  • socketServerMq exposes channelMq's API via a JSON schema over either a tcp or websocket connection.

Intended Use-Case

socketServerMq was designed to intergrate into the rest of the SuperLimitBreak live performance tool-chain, but is generic enough to be useful as a stand-alone websocket messaging system.

Json API

Interaction with the MQ is performed via the json API, over the socket stream.

###Example Json To send a json object to the key foobar you would send:

{
    "action": "message",
    "data": [
        {
            "deviceid": "foobar",
            "someOtherData": [
                "interesting", "data"
            ]
        }
    ]
}