# RabbitMQ Client for Vert.x

A Vert.x client allowing applications to interact with a RabbitMQ broker (AMQP 0.9.1)

This service is experimental and the APIs are likely to change before settling down.

## Getting Started

### Maven

Add the following dependency to your maven project

    <dependency>
      <groupId>io.vertx</groupId>
      <artifactId>vertx-rabbitmq-client</artifactId>
      <version>3.3.3</version>
    </dependency>

### Gradle

Add the following dependency to your gradle project

    dependencies {
      compile 'io.vertx:vertx-rabbitmq-client:3.3.3'
    }

### Create a client

You can create a client instance as follows using a full amqp uri:

    JsonObject config = new JsonObject();
    // full amqp uri
    config.put("uri", "amqp://xvjvsrrc:VbuL1atClKt7zVNQha0bnnScbNvGiqgb@moose.rmq.cloudamqp.com/xvjvsrrc");
    RabbitMQClient client = RabbitMQClient.create(vertx, config);

Or you can also specify individual parameters manually:

    JsonObject config = new JsonObject();
    // Each parameter is optional
    // The default parameter with be used if the parameter is not set
    config.put("user", "user1");
    config.put("password", "password1");
    config.put("host", "localhost");
    config.put("port", 5672);
    config.put("virtualHost", "vhost1");
    config.put("connectionTimeout", 60); // in seconds
    config.put("requestedHeartbeat", 60); // in seconds
    config.put("handshakeTimeout", 60); // in seconds
    config.put("requestedChannelMax", 5);
    config.put("networkRecoveryInterval", 5); // in seconds
    config.put("automaticRecoveryEnabled", true);

    RabbitMQClient client = RabbitMQClient.create(vertx, config);

## Operations

The following are some examples of the operations supported by the RabbitMQService API.

Consult the javadoc/documentation for detailed information on all API methods.

### Publish

Publish a message to a queue

    JsonObject message = new JsonObject().put("body", "Hello RabbitMQ, from Vert.x !");
    client.basicPublish("", "my.queue", message, pubResult -> {
      if (pubResult.succeeded()) {
        System.out.println("Message published !");
      } else {
        pubResult.cause().printStackTrace();
      }
    });

### Consume

Consume messages from a queue

    // Create the event bus handler which messages will be sent to
    vertx.eventBus().consumer("my.address", msg -> {
      JsonObject json = (JsonObject) msg.body();
      System.out.println("Got message: " + json.getString("body"));
    });

    // Setup the link between rabbitmq consumer and event bus address
    client.basicConsume("my.queue", "my.address", consumeResult -> {
      if (consumeResult.succeeded()) {
        System.out.println("RabbitMQ consumer created !");
      } else {
        consumeResult.cause().printStackTrace();
      }
    });

### Get

Will get a message from a queue

    client.basicGet("my.queue", true, getResult -> {
      if (getResult.succeeded()) {
        JsonObject msg = getResult.result();
        System.out.println("Got message: " + msg.getString("body"));
      } else {
        getResult.cause().printStackTrace();
      }
    });

### Consume messages without auto-ack

    vertx.eventBus().consumer("my.address", msg -> {
      JsonObject json = (JsonObject) msg.body();
      System.out.println("Got message: " + json.getString("body"));
      // ack
      client.basicAck(json.getLong("deliveryTag"), false, asyncResult -> {
      });
    });

    // Setup the link between rabbitmq consumer and event bus address
    client.basicConsume("my.queue", "my.address", false, consumeResult -> {
      if (consumeResult.succeeded()) {
        System.out.println("RabbitMQ consumer created !");
      } else {
        consumeResult.cause().printStackTrace();
      }
    });

## Running the tests

You will need to have RabbitMQ installed and running with default ports on localhost for this to work. <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>