@pubkeeper/brew-websocket

Pubkeeper WebSocket Brew

Installation

In a browser:

<script src="pubkeeper-brew-websocket.js"></script>

Using npm:

$ npm install --save @pubkeeper/brew-websocket

Then, load using ES5 require() syntax…

var WebSocketBrew = require('@pubkeeper/brew-websocket').WebSocketBrew;

…or with ES2015+ import syntax:

import { WebSocketBrew } from '@pubkeeper/brew-websocket';

Usage

Simple example, pointing to localhost…

const wsb = new WebSocketBrew({
  brewerConfig: {
    hostname: '127.0.0.1',
    port: 8080,
    secure: false,
  },
});

With multiple servers…

const wsbLocal = new WebSocketBrew({
  name: 'websocket-local',
  brewerConfig: {
    hostname: '127.0.0.1',
    port: 8080,
    secure: false,
  },
});

const wsbShared = new WebSocketBrew({
  name: 'websocket-shared',
  brewerConfig: {
    hostname: '10.10.0.21',
    port: 443,
    secure: true,
  },
});

const brews = [wsbLocal, wsbShared];

WebSocketBrew Class

The WebSocketBrew provides the connection management layer to publish to and read from the Pubkeeper WebSocket server.

new WebSocketBrew(options)

Name	Type	Description
options	BrewOptions	The options for this pubkeeper client

BrewOptions : object

These options can be given to a WebSocketBrew to customize its behavior.

Name	Type	Default	Description
name	string	'websocket'	brew name/id
brewerConfig	BrewerConfig?	null	The brew's brewer configuration
loopback	boolean	true	Enable/Disbale loopback messages
maxRetries	number	7	Maximum number of connection retries
maxTimeout	number	10000	Maximum timeout between retries (in milliseconds)

BrewerConfig : object

Name	Type	Description
hostname	string	hostname of the WebSocket server
port	number	port of the WebSocket server
secure	boolean	use wss:// or ws:// for server communication

Members

.name : string

Return the configured name of this brew.