snapshot of https://github.com/ThreeDotsLabs/watermill.git (master, 2026-09-15; blobs > 131072B omitted)

docs/content/pubsubs/amqp.md

@@ -0,0 +1,77 @@
++++
+title = "RabbitMQ (AMQP)"
+description = "The most widely deployed open source message broker"
+date = 2019-07-06T22:30:00+02:00
+bref = "The most widely deployed open source message broker"
+weight = 100
++++
+
+> RabbitMQ is the most widely deployed open source message broker.
+
+We are providing Pub/Sub implementation based on [github.com/rabbitmq/amqp091-go](https://github.com/rabbitmq/amqp091-go) official library.
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/doc.go" first_line_contains="// AMQP" last_line_contains="package amqp" padding_after="0" %}}
+
+You can find a fully functional example with RabbitMQ in the [Watermill examples](https://github.com/ThreeDotsLabs/watermill/tree/master/_examples/pubsubs/amqp).
+
+## Installation
+
+```bash
+go get github.com/ThreeDotsLabs/watermill-amqp/v3
+```
+
+### Characteristics
+
+| Feature | Implements | Note |
+| ------- | ---------- | ---- |
+| ConsumerGroups | yes* | there are no literal consumer groups in AMQP, but we can achieve similar behaviour with `GenerateQueueNameTopicNameWithSuffix`. For more details please check [AMQP "Consumer Groups" section](#amqp-consumer-groups) |
+| ExactlyOnceDelivery | no |  |
+| GuaranteedOrder | yes |  yes, please check https://www.rabbitmq.com/semantics.html#ordering |
+| Persistent | yes* | when using `NewDurablePubSubConfig` or `NewDurableQueueConfig`  |
+
+### Configuration
+
+Our AMQP is shipped with some pre-created configurations:
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/config.go" first_line_contains="// NewDurablePubSubConfig" last_line_contains="type Config struct {" %}}
+
+For detailed configuration description, please check [watermill-amqp/pkg/amqp/config.go](https://github.com/ThreeDotsLabs/watermill-amqp/tree/master/pkg/amqp/config.go)
+
+#### TLS Config
+
+TLS config can be passed to `Config.TLSConfig`.
+
+#### Connecting
+
+{{% load-snippet-partial file="src-link/_examples/pubsubs/amqp/main.go" first_line_contains="publisher, err :=" last_line_contains="panic(err)" padding_after="1" %}}
+
+{{% load-snippet-partial file="src-link/_examples/pubsubs/amqp/main.go" first_line_contains="subscriber, err :=" last_line_contains="panic(err)" padding_after="1" %}}
+
+### Publishing
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/publisher.go" first_line_contains="// Publish" last_line_contains="func (p *Publisher) Publish" %}}
+
+### Subscribing
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/subscriber.go" first_line_contains="// Subscribe" last_line_contains="func (s *Subscriber) Subscribe" %}}
+
+### Marshaler
+
+Marshaler is responsible for mapping AMQP's messages to Watermill's messages.
+
+Marshaller can be changed via the Configuration.
+If you need to customize thing in `amqp.Delivery`, you can do it `PostprocessPublishing` function.
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/marshaler.go" first_line_contains="// Marshaler" last_line_contains="func (d DefaultMarshaler)" padding_after="0" %}}
+
+### AMQP "Consumer Groups"
+
+AMQP doesn't provide mechanism like Kafka's "consumer groups". You can still achieve similar behaviour with `GenerateQueueNameTopicNameWithSuffix` and `NewDurablePubSubConfig`.
+
+{{% load-snippet-partial file="docs/snippets/amqp-consumer-groups/main.go" first_line_contains="func createSubscriber(" last_line_contains="go process(\"subscriber_2\", messages2)" %}}
+
+In this example both `pubSub1` and `pubSub2` will receive some messages independently.
+
+### AMQP `TopologyBuilder`
+
+{{% load-snippet-partial file="src-link/watermill-amqp/pkg/amqp/topology_builder.go" first_line_contains="// TopologyBuilder" last_line_contains="}" padding_after="0" %}}