Giter Club home page Giter Club logo

broadcast-ws's Introduction

broadcast-ws

BroadcastWS - WebSocket event-based broadcast service.

Public-domain Server

wss://relay.jdev.com.es/

Structure

๐Ÿ›ˆ All packets are in the JSON format

Once a WebSocket connection is open, the first Client->Server packet must be the Handshake packet. Every single packet sent after the Handshake packet must be a Data packet.

Handshake packet

{
    "clientID": "UUID v4 Client ID",
    "listens": [
        
    ]
}

Data packet

{
    "event": "Event ID in the format specified below",
}

Event ID format

The Event ID in the Data packet must be in the format specified below.

NAMESPACE:CATEGORY/EVENT

JS Library

There's also a JS library found in this repo at lib/broadcastws.min.js that wraps the WebSocket connection and adds some new methods.

BroadcastWS(clientID, listens) -> Creates a wrapped WebSocket object, send the handshake packet, and returns it.

On the wrapped WebSocket object there's a new method:

.event(eventID, data) -> Sends the data JSON object with the event property set.

broadcast-ws's People

Contributors

ainaracatgirl avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.