Using with SockJS

See sample at https://github.com/stomp-js/ng4-stompjs-demo/tree/sockjs

Almost all brokers that support SockJS also support WebSockets. If your application does not need to support old browsers, switch to using WebSockets. Check https://en.wikipedia.org/wiki/WebSocket for compatibility information.

Notes

• It is an initial release.
• Instead of a url in the default form, you need to pass it as a socketProvider function. It will be streamlined in a future release.
• Please read notes on SockJS support of the underlying library at https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/sockjs.md.html

Usage

Install SockJS Client

$ npm install sockjs-client --save

Import SockJS class

import * as SockJS from 'sockjs-client';

Implement a socketProvider

Create a function that returns an object similar to WebSocket (typically SockJS instance).

export function socketProvider() {
  return new SockJS('http://127.0.0.1:15674/stomp');
}

StompConfig

Pass the function as url in StompConfig. It will work even though name of the parameter is url, don't worry :)

Example:

const stompConfig: StompConfig = {
  // Which server?
  url: socketProvider,

  // Headers
  // Typical keys: login, passcode, host
  headers: {
    login: 'guest',
    passcode: 'guest'
  },

  // How frequent is the heartbeat?
  // Interval in milliseconds, set to 0 to disable
  heartbeat_in: 0, // Typical value 0 - disabled
  heartbeat_out: 20000, // Typical value 20000 - every 20 seconds

  // Wait in milliseconds before attempting auto reconnect
  // Set to 0 to disable
  // Typical value 5000 (5 seconds)
  reconnect_delay: 5000,

  // Will log diagnostics on console
  debug: true
};

Limitations

Copied from https://stomp-js.github.io/stomp-websocket/codo/extra/docs-src/sockjs.md.html

• SockJS is an emulation of WebSockets. This is not a complete implementation.
• Heart beating is not supported.
• SockJS internally uses one of many possible means to communicate. In some of those, auto reconnect may occasionally fail.

When Hacking Code of this Library

• When developing on this library code to use SockJS, please adjust the unit tests to use SockJS.
• Unit testes may occasionally fail in SockJS. It is because of limitations of SockJS around allowing only one SockJS connection at a time. Usually this should not affect your usage of the library.