Skip to content

Commit 0ffee67

Browse files
JSM topic exchange: README.md updates
* Mention the correct exchange type name, `x-jms-topic` * Do not mention 3.6 and building from source
1 parent 0e6779a commit 0ffee67

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

deps/rabbitmq_jms_topic_exchange/README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,48 +17,38 @@ Some related projects (e.g. a compliance test suite) and documentation are yet t
1717

1818
## Supported RabbitMQ Versions
1919

20-
This plugin targets RabbitMQ `3.6.0` and later versions.
20+
This plugin ships with RabbitMQ.
2121

2222
## Installation
2323

24-
This plugin ships with RabbitMQ starting with `3.6.3`. Enable it with
24+
Like all other plugins, this plugin must be enabled before it can be used.
25+
Enable it with
2526

2627
```
2728
[sudo] rabbitmq-plugins enable rabbitmq_jms_topic_exchange
2829
```
2930

30-
3131
## Design
3232

3333
The plugin this generates is a user-written exchange type for RabbitMQ
34-
client use. The exchange type name is "`x_jms_topic`" but this is _not_
34+
client use. The exchange type name is "`x-jms-topic`" but this is _not_
3535
a topic exchange. Instead it works together with a standard topic
3636
exchange to provide the JMS topic selection function.
3737

3838
When JMS Selectors are used on a Topic Destination consumer, the
39-
destination (queue) is bound to an exchange of type `x_jms_topic`, with
39+
destination (queue) is bound to an exchange of type `x-jms-topic`, with
4040
arguments that indicate what the selection criteria are. The
41-
`x_jms_topic` exchange is, in turn, bound to the standard Topic Exchange
41+
`x-jms-topic` exchange is, in turn, bound to the standard Topic Exchange
4242
used by JMS messaging (this uses the RabbitMQ exchange-to-exchange
4343
binding extension to the AMQP 0-9-1 protocol).
4444

4545
In this way, normal topic routing can occur, with the overhead of
4646
selection only applying when selection is used, and _after_ the routing
4747
and filtering implied by the topic name.
4848

49-
## Building From Source
50-
51-
Building is no different from [building other RabbitMQ plugins](https://www.rabbitmq.com/plugin-development.html).
52-
53-
TL;DR:
54-
55-
git clone https://github.com/rabbitmq/rabbitmq-jms-topic-exchange.git
56-
cd rabbitmq-jms-topic-exchange
57-
make -j dist
58-
ls plugins/*
5949

6050
## Copyright and License
6151

62-
(c) 2007-2020 VMware, Inc. or its affiliates.
52+
(c) 2007-2023 VMware, Inc. or its affiliates.
6353

6454
See [LICENSE](./LICENSE) for license information.

0 commit comments

Comments
 (0)