Stomp Dart

This library provides an implementation for a STOMP client connecting to a remote server. It should work for both pure dart and flutter.

Usage

Initialize

The client gets created the specified config, please see the Config section to see all available options

StompClient client = StompClient(
    config: StompConfig(
        url: 'wss://yourserver',
        onConnect: onConnectCallback
    )
);

The connect callback should be used to make sure that we are actually connected before we subscribe or send messages

void onConnectCallback(StompFrame connectFrame) {
    // client is connected and ready
}

Connect

client.activate();

client.subscribe(destination: '/foo/bar', headers: {}, callback: (frame) {
    // Received a frame for this subscription
    print(frame.body);
})

Ack/Nack

client.ack(id: message-id, headers: headers);

client.nack(id: message-id, headers: headers);

Unsubscribe

client.subscribe(...) returns a function which can be called with an optional map of headers

dynamic unsubscribeFn = client.subscribe(destination: '/foo/bar', headers: {}, callback: (frame) {
    // Received a frame for this subscription
    print(frame.body);
})
...
unsubscribeFn(unsubscribeHeaders: {});

Send

client.send(destination: '/foo/bar', body: 'Your message body', headers: {});

Disconnect

client.deactivate();

StompConfig

This table shows all available options in StompConfig

Option	Description
url: String	The url of the server you want connect to (required)
reconnectDelay: Duration	Time duration between reconnect attempts. Set to 0 ms if you don't want to reconnect automatically
heartbeatOutgoing: Duration	Time duration between outgoing heartbeat messages. Set to 0 ms to not send any heartbeats
heartbeatIncoming: Duration	Time duration between incoming heartbeat messages. Set to 0 ms to not receive any heartbeats
connectionTimeout: Duration	Time duration it waits until a connection attempt is aborted
stompConnectHeaders: Map<String, String>	Optional header values which will be used on the STOMP connect frame
webSocketConnectHeaders: Map<String, dynamic>	Optional header values which will be used when connecting to the underyling WebSocket (not supported in Web)
beforeConnect: Future	A async function which will be awaited before a connection is established.
onConnect: Function(StompFrame)	Function to be called when the client successfully connected to the server.
onDisconnect: Function(StompFrame)	Function to be called when the client disconnects expectedly
onStompError: Function(StompFrame)	Function to be called when the stomp server sends an error frame
onUnhandledFrame: Function(StompFrame)	Function to be called when the server sends a unrecognized frame
onUnhandledMessage: Function(StompFrame)	Function to be called when a subscription message does not have a handler
onUnhandledReceipt: Function(StompFrame)	Function to be called when a receipt message does not have a registered watcher
onWebSocketError: Function(dynamic)	Function to be called when the underyling WebSocket throws an error
onWebSocketDone: Function()	Function to be called when the underyling WebSocket is done/disconnected
onDebugMessage: Function(String)	Function to be called for debug messages generated by the internal message handler

Use Stomp with SockJS

Use StompConfig.SockJS constructor instead of default StompConfig constructor.

StompClient client = StompClient(
    config: StompConfig.SockJS(
        url: 'https://yourserver',
        onConnect: onConnectCallback
    )
);

Evaluation of headers

The STOMP client checks the content-type while parsing a received message. If the header contains the value application/octet-stream the message body will be treated as binary data. The resulting StompFrame will have a binaryBody. The body of the frame will be empty in this case. The same is true if the content-type header is missing.

Development

Running unit tests

dart run test -p "chrome,vm" test/

Generating coverage data

dart pub global activate coverage
dart pub global run coverage:collect_coverage --port=8111 --out=coverage.json --wait-paused --resume-isolates & dart --disable-service-auth-codes --enable-vm-service=8111 --pause-isolates-on-exit test/test_all.dart

And to convert to lcov

dart pub global run coverage:format_coverage --lcov --in=coverage.json --out=lcov.info --packages=.packages --report-on=lib