https://github.com/rikulo/stomp

STOMP Dart Client for communicating with STOMP-compliant messaging servers.
https://github.com/rikulo/stomp

Last synced: about 1 year ago
JSON representation

STOMP Dart Client for communicating with STOMP-compliant messaging servers.

• Host: GitHub
• URL: https://github.com/rikulo/stomp
• Owner: rikulo
• License: other
• Created: 2013-08-07T08:46:40.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2020-01-10T15:55:51.000Z (over 6 years ago)
• Last Synced: 2025-05-09T00:52:11.327Z (about 1 year ago)
• Language: Dart
• Homepage: http://rikulo.org
• Size: 89.8 KB
• Stars: 30
• Watchers: 3
• Forks: 24
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# STOMP Dart Client

[STOMP](http://stomp.github.io/) Dart client for communicating with STOMP complaint messaging brokers and servers.

* [Home](http://rikulo.org)

* [API Reference](http://www.dartdocs.org/documentation/stomp/0.8.0)

* [Discussion](http://stackoverflow.com/questions/tagged/rikulo)

* [Git Repository](https://github.com/rikulo/stomp)

* [Issues](https://github.com/rikulo/stomp/issues)

Stomp Dart Client is distributed under an Apache 2.0 License.

[![Build Status](https://drone.io/github.com/rikulo/stomp/status.png)](https://drone.io/github.com/rikulo/stomp/latest)

> See also [Ripple - Lightweight Dart Messaging Server](https://github.com/rikulo/ripple).

## Installation

Add this to your `pubspec.yaml` (or create it):

    dependencies:

      stomp:

Then run the [Pub Package Manager](http://pub.dartlang.org/doc) (comes with the Dart SDK):

    pub install

## Usage

### Running on Dart VM

    import "package:stomp/stomp.dart";

    import "package:stomp/vm.dart" show connect;

    void main() {

      connect("foo.server.com").then((StompClient client) {

        client.subscribeString("/foo",

          (Map headers, String message) {

            print("Recieve $message");

          });

        client.sendString("/foo", "Hi, Stomp");

      });

    }

There are basically a few alternative ways to communicate:

* JSON objects: `sendJson()` and `subscribeJson()`

* Strings: `sendString()` and `subscribeString()`

* Bytes: `sendBytes()` and `subscribeBytes()`

* BLOB (huge data): `sendBlob()` and `subscribeBlob()`

> Please refer to [StompClient](http://api.rikulo.org/stomp/latest/stomp/StompClient.html) for more information.

### Running on Browser

The same as the above, except import `websocket.dart` instead of `vm.dart`:

    import "package:stomp/stomp.dart";

    import "package:stomp/websocket.dart" show connect;

    //the rest is the same as running on Dart VM

## Limitations

* Support STOMP 1.2 or above

* Support UTF-8 encoding

## Incompleteness

* Heart beat not supported.