dart_amqp 0.1.4
dart_amqp: ^0.1.4 copied to clipboard

Dart AMQP client implementing protocol version 0.9.1

dart_ampq #

Build Status Coverage Status

Dart AMQP client implementing protocol version 0.9.1

Main features:

  • asynchronous API based on Futures and Streams
  • supports PLAIN and AMQPLAIN authentication providers while other authentication schemes can be plugged in by implementing the appropriate interface.
  • implements the entire 0.9.1 protocol specification (except basic get and recover-async)
  • supports both plain-text and TLS connections

Things not working yet:

  • the driver does not currently support recovering client topologies when re-establishing connections. This feature may be implemented in a future version.
  • heartbeats.

Quick start #

Listening to a queue:

import "package:dart_amqp/dart_amqp.dart";

void main() {
  Client client = new Client();

  .channel() // auto-connect to localhost:5672 using guest credentials
  .then((Channel channel) => channel.queue("hello"))
  .then((Queue queue) => queue.consume())
  .then((Consumer consumer) => consumer.listen((AmqpMessage message) {
    // Get the payload as a string
    print(" [x] Received string: ${message.payloadAsString}");

    // Or unserialize to json
    print(" [x] Received json: ${message.payloadAsJson}");

    // Or just get the raw data as a Uint8List
    print(" [x] Received raw: ${message.payload}");
    // The message object contains helper methods for 
    // replying, ack-ing and rejecting

Sending messages via an exchange:

import "package:dart_amqp/dart_amqp.dart";

void main() {
  // You can provide a settings object to override the
  // default connection settings
  ConnectionSettings settings = new ConnectionSettings(
      host : "remote.amqp.server.com",
      authProvider : new PlainAuthenticator("user", "pass")
  Client client = new Client(settings : settings);
  .then((Channel channel) => channel.exchange("logs", ExchangeType.FANOUT))
  .then((Exchange exchange) {
    // We dont care about the routing key as our exchange type is FANOUT
    exchange.publish("Testing 1-2-3", null);
    return client.close();

Api #

See the Api documentation.

RPC calls over AMQP #

This example illustrates how to get a basic RPC server/client up and running using just the provided api calls.

The driver does not provide any helper classes for easily performing RPC calls over AMQP as not everyone needs this functionality. If you need RPC support for your application you may want to consider using the dart_amqp_rpc package.

Examples #

The example folder contains implementations of the six RabbitMQ getting started tutorials.

Contributing #

See the Contributing Guide.

License #

dart_amqp is distributed under the MIT license.

pub points

Dart AMQP client implementing protocol version 0.9.1

Repository (GitHub)
View/report issues


API reference








Packages that depend on dart_amqp