JSM topic exchange: README.md updates

* Mention the correct exchange type name, `x-jms-topic`
* Do not mention 3.6 and building from source
This commit is contained in:
Michael Klishin 2023-04-15 14:20:45 +04:00 committed by GitHub
parent 0e6779a672
commit 0ffee67ac5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 17 deletions

View File

@ -17,28 +17,28 @@ Some related projects (e.g. a compliance test suite) and documentation are yet t
## Supported RabbitMQ Versions
This plugin targets RabbitMQ `3.6.0` and later versions.
This plugin ships with RabbitMQ.
## Installation
This plugin ships with RabbitMQ starting with `3.6.3`. Enable it with
Like all other plugins, this plugin must be enabled before it can be used.
Enable it with
```
[sudo] rabbitmq-plugins enable rabbitmq_jms_topic_exchange
```
## Design
The plugin this generates is a user-written exchange type for RabbitMQ
client use. The exchange type name is "`x_jms_topic`" but this is _not_
client use. The exchange type name is "`x-jms-topic`" but this is _not_
a topic exchange. Instead it works together with a standard topic
exchange to provide the JMS topic selection function.
When JMS Selectors are used on a Topic Destination consumer, the
destination (queue) is bound to an exchange of type `x_jms_topic`, with
destination (queue) is bound to an exchange of type `x-jms-topic`, with
arguments that indicate what the selection criteria are. The
`x_jms_topic` exchange is, in turn, bound to the standard Topic Exchange
`x-jms-topic` exchange is, in turn, bound to the standard Topic Exchange
used by JMS messaging (this uses the RabbitMQ exchange-to-exchange
binding extension to the AMQP 0-9-1 protocol).
@ -46,19 +46,9 @@ In this way, normal topic routing can occur, with the overhead of
selection only applying when selection is used, and _after_ the routing
and filtering implied by the topic name.
## Building From Source
Building is no different from [building other RabbitMQ plugins](https://www.rabbitmq.com/plugin-development.html).
TL;DR:
git clone https://github.com/rabbitmq/rabbitmq-jms-topic-exchange.git
cd rabbitmq-jms-topic-exchange
make -j dist
ls plugins/*
## Copyright and License
(c) 2007-2020 VMware, Inc. or its affiliates.
(c) 2007-2023 VMware, Inc. or its affiliates.
See [LICENSE](./LICENSE) for license information.