ZIO AMQP

ZIO AMQP is a ZIO-based wrapper around the RabbitMQ Java client. It exposes queues as ZStreams of deliveries and serializes access to the underlying RabbitMQ channel, so concurrent fibers cannot corrupt it. Connections and channels are scoped resources: they are closed automatically when the Scope that owns them ends, even if the program fails or is interrupted.

Installation

Add the following line to your build.sbt file:

libraryDependencies += "dev.zio" %% "zio-amqp" % "1.0.1"

ZIO AMQP depends on ZIO 2 and the RabbitMQ Java client, and is published for Scala 2.12, 2.13 and 3.

A First Program

The program below connects to a broker on localhost:5672 with the default guest/guest credentials, declares a queue, publishes one message to it, and consumes that message back. Both the connection and the channel are scoped resources, so ZIO.scoped closes them when the program ends:

import zio._
import zio.amqp._
import zio.amqp.model._

val queue = QueueName("hello")

val program: ZIO[Any, Throwable, Unit] =
  ZIO.scoped {
    for {
      connection <- Amqp.connect(AMQPConfig.default)
      channel    <- Amqp.createChannel(connection)
      _          <- channel.queueDeclare(queue)
      _          <- channel.publish(ExchangeName(""), "Hello, AMQP!".getBytes, RoutingKey("hello"))
      _          <- channel
                      .consume(queue, ConsumerTag("first-program"))
                      .mapZIO { delivery =>
                        Console.printLine(new String(delivery.getBody)) *>
                          channel.ack(DeliveryTag(delivery.getEnvelope.getDeliveryTag))
                      }
                      .take(1)
                      .runDrain
    } yield ()
  }

Publishing to the default exchange (the empty name ExchangeName("")) with the queue's name as the routing key delivers the message straight to that queue. The consume stream stays open until it is completed, here by take(1), which also cancels the consumer on the broker.

Where to Go Next

If you are new to AMQP, start with the tutorial, which builds a producer and a pool of competing consumers step by step.

For a specific task, pick a how-to guide:

• Connect to a Broker
• Acknowledge Messages
• Limit Prefetch to Apply Back-Pressure
• Route Messages with Exchanges
• Publish Durable Messages
• Stop a Consumer
• Test with Testcontainers

To look up a type or method, use the reference pages:

• Amqp and AMQPConfig: create connections and channels.
• Channel: declare queues and exchanges, publish, consume and acknowledge.
• Model Types: QueueName, ExchangeName, RoutingKey, ConsumerTag, DeliveryTag, AmqpUri and ExchangeType.

Documentation

Learn more on the ZIO AMQP homepage!

Contributing

For the general guidelines, see ZIO contributor's guide.

Code of Conduct

See the Code of Conduct

Support

Come chat with us on .

License

License