README.md

Reactor RabbitMQ

(master) (1.4.x)

Reactor RabbitMQ is a reactive API for RabbitMQ based on Reactor and RabbitMQ Java Client. Reactor RabbitMQ API enables messages to be published to RabbitMQ and consumed from RabbitMQ using functional APIs with non-blocking back-pressure and very low overheads. This enables applications using Reactor to use RabbitMQ as a message bus or streaming platform and integrate with other systems to provide an end-to-end reactive pipeline.

Getting started

For the latest stable release, please see the getting started section in the reference documentation. You can view the Javadoc as well.

For latest milestone: Getting Started - Reference Documentation - Javadoc

For snapshots: Getting Started - Reference Documentation - Javadoc

Building applications using Reactor RabbitMQ API

You need to have Java 8 installed.

With Maven:

<dependency>
    <groupId>io.projectreactor.rabbitmq</groupId>
    <artifactId>reactor-rabbitmq</artifactId>
    <version>1.5.6</version>
</dependency>

With Gradle:

dependencies {
  compile "io.projectreactor.rabbitmq:reactor-rabbitmq:1.5.6"
}

Milestones and release candidates

With Maven:

<dependency>
    <groupId>io.projectreactor.rabbitmq</groupId>
    <artifactId>reactor-rabbitmq</artifactId>
    <version>1.5.6</version>
</dependency>

<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

With Gradle:

repositories {
  maven { url 'https://repo.spring.io/milestone' }
  mavenCentral()
}

dependencies {
  compile "io.projectreactor.rabbitmq:reactor-rabbitmq:1.5.6"
}

Snapshots

With Maven:

<dependency>
    <groupId>io.projectreactor.rabbitmq</groupId>
    <artifactId>reactor-rabbitmq</artifactId>
    <version>1.5.7-SNAPSHOT</version>
</dependency>

<repositories>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/libs-snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

With Gradle:

repositories {
  maven { url 'https://repo.spring.io/libs-snapshot' }
  mavenCentral()
}

dependencies {
  compile "io.projectreactor.rabbitmq:reactor-rabbitmq:1.5.7-SNAPSHOT"
}

Build instructions

Building Reactor RabbitMQ jars

./gradlew jar

Running tests

The test suite needs to execute rabbitmqctl to test connection recovery. You can specify the path to rabbitmqctl like the following:

./gradlew check -Drabbitmqctl.bin=/path/to/rabbitmqctl

You need a local running RabbitMQ instance.

Running tests with Docker

Start a RabbitMQ container:

docker run -it --rm --name rabbitmq -p 5672:5672 rabbitmq:3.9

Run the test suite:

./gradlew check -i -s

Building IDE project

./gradlew eclipse
./gradlew idea

Versioning

Reactor RabbitMQ used semantic versioning from version 1.0 to version 1.4, but switched to another scheme for consistency with Reactor Core and the other Reactor libraries.

Starting from 1.4, Reactor RabbitMQ uses a GENERATION.MAJOR.MINOR scheme, whereby an increment in:

• GENERATION marks a change of library generation. Expect improvements, new features, bug fixes, and incompatible API changes.
• MAJOR marks a significant release. Expect new features, bug fixes, and small incompatible API changes.
• MINOR marks a maintenance release. Expect new features and bug fixes, but no incompatible API changes.

Community / Support

• For Reactor and Reactor RabbitMQ questions:
• For RabbitMQ questions: RabbitMQ Users
• For reporting bugs and feature requests: GitHub Issues

See the RabbitMQ Java libraries support page for the support timeline of this library.

License

Reactor RabbitMQ is Apache 2.0 licensed.

Sponsored by VMware