This package has been deprecated

Author message:

Starting with signal-fire v0.3.0, use signal-fire-relay

signal-fire-relay-mqtt

0.3.0 • Public • Published

WebRTC Signaling Server for node.js

Standard - JavaScript Style Guide

Note: Starting with signal-fire 0.4.0, this relay is deprecated. Use signal-fire-relay instead!

signal-fire-relay-mqtt is a relay for signal-fire, a horizontally scalable signaling server for WebRTC. This module can be used as a reference implementation for writing your own relays.

For more information about the actual server module, see signal-fire.

Install

Install using npm:

npm i signal-fire-relay-mqtt --save

Usage

It's easy to add the relay to signal-fire:

const Server = require('signal-fire').Server
const Relay = require('signal-fire-relay-mqtt').Relay
 
const relay = new Relay('mqtt://broker.hivemq.com', {
  // These options are passed to `mqtt.connect()`
})
 
// Create a server with the relay set
const server = new Server({
  relay: relay
})

That's all!

Changelog

  • v0.3.0
    • Added deprecation notice. Starting with signal-fire v0.4.0, use signal-fire-relay instead!
  • v0.2.1
    • Fix package naming mixup
  • v0.2.0
    • The error event on the MQTT connection is now re-emitted
    • Renamed .relay() to .send() (breaking change, only compatible with signal-fire 0.3.0 or higher!)
  • v0.1.0
    • Initial release

Standard - JavaScript Style Guide

License

Copyright 2016 Michiel van der Velde.

This software is licensed under the MIT License.

Package Sidebar

Install

npm i signal-fire-relay-mqtt

Weekly Downloads

0

Version

0.3.0

License

MIT

Last publish

Collaborators

  • michielvdvelde