summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcial Rosales <mrosales@pivotal.io>2023-04-05 09:27:50 +0200
committerMarcial Rosales <mrosales@pivotal.io>2023-04-05 09:27:50 +0200
commit6d4b648d58c498ada69278e57563690c98ad5964 (patch)
treed88d7b6c476a4366b9d029b284a4bb3de512fa61
parent17be12421cbab89a3b820b83d3e8a546e37f3231 (diff)
downloadrabbitmq-server-git-prototype-local-exchange.tar.gz
-rw-r--r--deps/rabbitmq_local_exchange/README.md25
1 files changed, 22 insertions, 3 deletions
diff --git a/deps/rabbitmq_local_exchange/README.md b/deps/rabbitmq_local_exchange/README.md
index 2cda6f0cfc..d115dc6c4d 100644
--- a/deps/rabbitmq_local_exchange/README.md
+++ b/deps/rabbitmq_local_exchange/README.md
@@ -1,10 +1,21 @@
# RabbitMQ Local Exchange Type
-TODO
+This exchange type favours local bound queues (local to the producer's connection). It's basically
+a direct exchange, with the exception that, only one queue and in particular, a queue local to the
+producer's connection receives the message. If there are no local queues, the exchange behaves like
+the random exchange, i.e. it randomly picks the target queue.
+
## Installation
-TODO
+Install the corresponding .ez files from our
+[GitHub releases](https://github.com/rabbitmq/rabbitmq-local-exchange/releases)
+Then run the following command:
+
+```bash
+rabbitmq-plugins enable rabbitmq_local_exchange
+```
+
## Building from Source
@@ -24,7 +35,15 @@ and enable the plugin:
## Usage
-TODO
+To create a _local_, just declare an exchange providing the type `"x-local"`.
+
+```java
+channel.exchangeDeclare("cache-updates", "x-local");
+```
+
+and bind several queues to it preferably if each queue is created on a different node.
+Routing keys will be ignored.
+
## License