StompBrokerJS

NodeJS StompBroker

This is simple NodeJs STOMP 1.1 broker for embedded usage.

Features

Destination wildcards
- . is used to separate names in a path
- * is used to mach any name in a path
- ** is used to recursively match path names

TODO

Authorization
Acknowledgment
Async send messages
Transactions
Composite Destinations
Message selectors

Changelog

0.1.0 First working version.
0.1.1 Added wildcards to destination, change subscribe method [no backward compatibility]
0.1.2 Bug fixes, changed websocket library, updated documentation.
1.1.1 Unsubscribe on server, updated documentation, added events.
1.1.2 Binary data sending, updated documentation, allowed server name modification.
1.2.0 Added heartbeat.

Example

var http = require("http");
var StompServer = require('stomp-broker-js');

var server = http.createServer();
var stompServer = new StompServer({server: server});

server.listen(61614);

stompServer.subscribe("/**", function(msg, headers) {
  var topic = headers.destination;
  console.log(topic, "->", msg, headers);
});

stompServer.send('/test', {}, 'testMsg');

#Documentation

Classes

StompServer ⇐ EventEmitter

Typedefs

ServerConfig : object: STOMP Server configuration
OnSubscribedMessageCallback : function: Subscription callback method
MsgFrame : object: Message frame

StompServer ⇐ `EventEmitter`

Kind: global class
Extends: EventEmitter

StompServer ⇐ EventEmitter
- new StompServer(config)
- .onUnsubscribe() ⇒ boolean
- .subscribe(topic, [callback], headers) ⇒ string
- .unsubscribe(id) ⇒ boolean
- .send(topic, headers, body)
- .frameSerializer(frame) ⇒ MsgFrame
- .frameParser(frame) ⇒ MsgFrame
- "error"
- "connecting"
- "connected"
- "disconnected"
- "send"
- "subscribe"
- "unsubscribe"

new StompServer(config)

Param	Type	Description
config	`ServerConfig`	Configuration for STOMP server

stompServer.onUnsubscribe() ⇒ `boolean`

Kind: instance method of StompServer

stompServer.subscribe(topic, [callback], headers) ⇒ `string`

Subsribe topic

Kind: instance method of StompServer
Returns: string - Subscription id, when message is received event with this id is emitted

Param	Type	Description
topic	`string`	Subscribed destination, wildcard is supported
[callback]	`OnSubscribedMessageCallback`	Callback function
headers	`object`	Optional headers, used by client to provide a subscription ID (headers.id)

Example

stompServer.subscribe("/test.data", function(msg, headers) {}, headers);
//or alternative
var subs_id = stompServer.subscribe("/test.data");
stompServer.on(subs_id, function(msg, headers) {});

stompServer.unsubscribe(id) ⇒ `boolean`

Unsubscribe topic with subscription id

Kind: instance method of StompServer
Returns: boolean - Subscription is deleted

Param	Type	Description
id	`string`	Subscription id

stompServer.send(topic, headers, body)

Send message to topic

Kind: instance method of StompServer

Param	Type	Description
topic	`string`	Destination for message
headers	`object`	Message headers
body	`string`	Message body, can be Buffer object

stompServer.frameSerializer(frame) ⇒ `MsgFrame`

Serialize frame to string for send

Kind: instance method of StompServer
Returns: MsgFrame - modified frame

Param	Type	Description
frame	`MsgFrame`	Message frame

stompServer.frameParser(frame) ⇒ `MsgFrame`

Parse frame to object for reading

Kind: instance method of StompServer
Returns: MsgFrame - modified frame

Param	Type	Description
frame	`MsgFrame`	Message frame

"error"

Client error event

Kind: event emitted by StompServer