ripple 0.5.3

  • README.md
  • Installing
  • Versions
  • 10

#Ripple

Lightweight Dart messaging server; supporting STOMP messaging protocol.

See also Stomp Dart Client.

Build Status

##Installation

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

dependencies:
  ripple:

Then run the Pub Package Manager (comes with the Dart SDK):

pub install

##Usage

First, you have to import:

import "package:ripple/ripple.dart";

Then, you can start Ripple server by binding it to any number of Internet addresses and ports.

new RippleServer()
  ..start() //bind to port 61626
  ..startSecure(); //bind to port 61627 and using SSL

For how to use a STOMP client to access Ripple server, please refer to STOMP Dart Client.

###WebSocket

You can have Ripple server to serve a WebSocket connection. For example,

HttpServer httpServer;
RippleServer rippleServer;
...
httpServer.listen((request) {
  if (...) { //usually test request.uri to see if it is mapped to WebSocket
    WebSocketTransformer.upgrade(request).then((WebSocket webSocket) {
      rippleServer.serveWebSocket(webSocket);
    }).catchError((ex) {
      // Handle error
    });
  } else {
    // Do normal HTTP request processing.
  }
});

##Limitations

  • Support STOMP 1.2 or above
  • Support UTF-8 encoding

##Incompleteness

  • Transaction not supported.
  • Heart beat not supported.
  • ACK and NACK not supported.

##Potential Enhancement

  • Support subscribeBlob() better. Currently, messages will be held in the memory before sending to subscribers. It could be an issue if the message is huge.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  ripple: ^0.5.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:ripple/ripple.dart';
  
Version Uploaded Documentation Archive
0.5.3 Nov 5, 2013 Go to the documentation of ripple 0.5.3 Download ripple 0.5.3 archive
0.5.2 Oct 29, 2013 Go to the documentation of ripple 0.5.2 Download ripple 0.5.2 archive
0.5.1 Aug 15, 2013 Go to the documentation of ripple 0.5.1 Download ripple 0.5.1 archive
0.5.0 Aug 14, 2013 Go to the documentation of ripple 0.5.0 Download ripple 0.5.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
21
Health:
Code health derived from static analysis. [more]
0
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
0
Overall:
Weighted score of the above. [more]
10
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because ripple depends on stomp any which requires SDK version <2.0.0, version solving failed.

Health suggestions

Format lib/plugin.dart.

Run dartfmt to format lib/plugin.dart.

Format lib/ripple.dart.

Run dartfmt to format lib/ripple.dart.

Format lib/src/connect.dart.

Run dartfmt to format lib/src/connect.dart.

Fix additional 3 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/connect_impl.dart (Run dartfmt to format lib/src/connect_impl.dart.)
  • lib/src/connect_util.dart (Run dartfmt to format lib/src/connect_util.dart.)
  • lib/src/server_impl.dart (Run dartfmt to format lib/src/server_impl.dart.)

Maintenance issues and suggestions

Fix platform conflicts. (-20 points)

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Package is too old. (-100 points)

The package was released more than two years ago.

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

Maintain an example.

None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use ripple.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=0.8.7