stomp-protocol

STOMP Protocol for NodeJS

An implementation of the STOMP Protocol for NodeJS, both client-side & server-side. It does not implement a fully functional broker, but it's intended as an API for building complex asynchronous applications based on the STOMP protocol.

Note: the npm package has been renamed to stomp-protocol in order to be compliant with naming conventions.

Ready for TypeScript

I developed this module using Typescript and the npm package is already provided with d.ts typings.

Installation

Run npm to install the package:

npm install stomp-protocol --save

Import the module using the standard syntax:

import * as stomp from 'stomp-protocol';

Client example

The following example shows how to connect to a STOMP server using this library. We use net.Socket here, but the library is ready for WebSockets, too.

import { StompHeaders, StompError, StompServerCommandListener, createStompClientSession } from 'stomp-protocol';
import { Socket, createConnection } from 'net';
 
const listener: StompServerCommandListener = { // 1) define a listener for server-sent frames.
    connected(headers: StompHeaders) {
        console.log('Connected!', headers);
    },
    message(headers: StompHeaders, body?: string) {
        console.log('Message!', body, headers);
    },
    receipt(headers: StompHeaders) {
        console.log('Receipt!', headers);
    },
    error(headers: StompHeaders, body?: string) {
        console.log('Error!', headers, body);
    },
    onProtocolError(error: StompError) {
        console.log('Protocol error!', error);
    },
    onEnd() {
        console.log('End!');
    }
};
 
const socket = createConnection(9999, '127.0.0.1'); // 2) Open raw TCP socket to the server.
 
const client = createStompClientSession(socket, listener); // 3) Start a STOMP Session over the TCP socket.
 
client.connect({login:'user', passcode:'pass'}).catch(console.error); // 4) Send the first frame!

You can also use a listener class constructor accepting a StompClientSessionLayer parameter. This decouples connection creation from protocol management:

 
class MyServerListener implements StompServerCommandListener {
 
    constructor(private readonly session: StompClientSessionLayer) { }
 
    // server listeners here...
}
 
createStompClientSession(socket, MyServerListener);
 

Server example

import { StompHeaders, StompError, StompClientCommandListener, createStompServerSession } from 'stomp-protocol';
import { Socket, createServer } from 'net';
 
function testServer(socket: Socket) { // 1) create a listener for incoming raw TCP connections.
 
    const listener: StompClientCommandListener = { // 2) define a listener for client-sent frames.
 
        connect(headers: StompHeaders) {
            console.log('Connect!', headers);
            if (headers && headers.login === 'user' && headers.passcode === 'pass') {
                server.connected({ version: '1.2', server: 'MyServer/1.8.2' }).catch(console.error);
            } else {
                server.error({ message: 'Invalid login data' }, 'Invalid login data').catch(console.error);
            }
        },
        send(headers: StompHeaders, body?: string) {
            console.log('Send!', body, headers);
        },
        subscribe(headers: StompHeaders) {
            console.log('subscription done to ' + (headers && headers.destination));
        },
        unsubscribe(headers: StompHeaders) {
            console.log('unsubscribe', headers);
        },
        begin(headers: StompHeaders) {
            console.log('begin', headers);
        },
        commit(headers: StompHeaders) {
            console.log('commit', headers);
        },
        abort(headers: StompHeaders) {
            console.log('abort', headers);
        },
        ack(headers: StompHeaders) {
            console.log('ack', headers);
        },
        nack(headers: StompHeaders) {
            console.log('nack', headers);
        },
        disconnect(headers: StompHeaders) {
            console.log('Disconnect!', headers);
        },
        onProtocolError(error: StompError) {
            console.log('Protocol error!', error);
        },
        onEnd() {
            console.log('End!');
        }
    };
 
    const server = createStompServerSession(socket, listener);  // 3) Start a STOMP Session over the TCP socket.
}
 
const server = createServer(testServer); // 4) Create a TCP server
 
server.listen(9999, 'localhost'); // 5) Listen for incoming connections

As in the client example, you can also use a listener class constructor accepting a StompServerSessionLayer parameter:

 
class MyClientListener implements StompClientCommandListener {
 
    constructor(private readonly session: StompServerSessionLayer) { }
 
    // client listeners here...
}
 
function testServer(socket: Socket) {
    createStompServerSession(socket, MyServerListener);
}
 
const server = createServer(testServer);
 
server.listen(9999, 'localhost');
 

Credits

This project includes some code by node-stomp-client.

License

Released with MIT License.