mirror of
https://github.com/apache/activemq-artemis.git
synced 2025-02-06 18:18:43 +00:00
3a4b421d2e
Markdown, which is currently used for user-facing documentation, is good for a lot of things. However, it's not great for the kind of complex documentation we have and our need to produce both multi-page HTML and single-page PDF output via Maven. Markdown lacks features which would make the documentation easier to read, easier to navigate, and just look better overall. The current tool-chain uses honkit and a tool called Calibre. Honkit is written in TypeScript and is installed via NPM. Calibre is a native tool so it must be installed via an OS-specific package manager. All this complexity makes building, releasing, uploading, etc. a pain. AsciiDoc is relatively simple like Markdown, but it has more features for presentation and navigation not to mention Java-based Maven tooling to generate both HTML and PDF. Migrating will improve both the appearance of the documentation as well as the processes to generate and upload it. This commit contains the following changes: - Convert all the Markdown for the User Manual, Migration Guide, and Hacking guide to AsciiDoc via kramdown [1]. - Update the `artemis-website` build to use AsciiDoctor Maven tooling. - Update `RELEASING.md` with simplified instructions. - Update Hacking Guide with simplified instructions. - Use AsciiDoc link syntax in Artemis Maven doc plugin. - Drop EPUB & MOBI docs for User Manual as well as PDF for the Hacking Guide. All docs will be HTML only except for the User Manual which will have PDF. - Move all docs up out of their respective "en" directory. This was a hold-over from when we had docs in different languages. - Migration & Hacking Guides are now single-page HTML since they are relatively short. - Refactor README.md to simplify and remove redundant content. Benefits of the change: - Much simplified tooling. No more NPM packages or native tools. - Auto-generated table of contents for every chapter. - Auto-generated anchor links for every sub-section. - Overall more appealing presentation. - All docs will use the ActiveMQ favicon. - No more manual line-wrapping! AsciiDoc recommends one sentence per line and paragraphs are separated by a blank line. - AsciiDoctor plugins for IDEA are quite good. - Resulting HTML is less than *half* of the previous size. All previous links/bookmarks should continue to work. [1] https://github.com/asciidoctor/kramdown-asciidoc
52 lines
1.8 KiB
Plaintext
52 lines
1.8 KiB
Plaintext
= Exclusive Queues
|
|
:idprefix:
|
|
:idseparator: -
|
|
|
|
Exclusive queues are special queues which dispatch all messages to only one consumer at a time.
|
|
|
|
This is useful when you want all messages to be processed _serially_ but you can't or don't want to use xref:message-grouping.adoc#message-grouping[Message Grouping].
|
|
|
|
An example might be orders sent to an address and you need to consume them in the exact same order they were produced.
|
|
|
|
Obviously exclusive queues have a draw back that you cannot scale out the consumers to improve consumption as only one consumer would technically be active.
|
|
Here we advise that you look at message groups first.
|
|
|
|
== Configuring Exclusive Queues
|
|
|
|
Exclusive queues can be statically configured using the `exclusive` boolean property:
|
|
|
|
[,xml]
|
|
----
|
|
<address name="foo.bar">
|
|
<multicast>
|
|
<queue name="orders1" exclusive="true"/>
|
|
</multicast>
|
|
</address>
|
|
----
|
|
|
|
Specified on creating a Queue by using the CORE api specifying the parameter `exclusive` to `true`.
|
|
|
|
Or on auto-create when using the JMS Client by using address parameters when creating the destination used by the consumer.
|
|
|
|
[,java]
|
|
----
|
|
Queue queue = session.createQueue("my.destination.name?exclusive=true");
|
|
Topic topic = session.createTopic("my.destination.name?exclusive=true");
|
|
----
|
|
|
|
Also the default for all queues under and address can be defaulted using the `address-setting` configuration:
|
|
|
|
[,xml]
|
|
----
|
|
<address-setting match="lastValueQueue">
|
|
<default-exclusive-queue>true</default-exclusive-queue>
|
|
</address-setting>
|
|
----
|
|
|
|
By default, `default-exclusive-queue` is `false`.
|
|
Address xref:wildcard-syntax.adoc#wildcard-syntax[wildcards] can be used to configure exclusive queues for a set of addresses.
|
|
|
|
== Example
|
|
|
|
See the xref:examples.adoc#exclusive-queue[exclusive queue example] which shows how exclusive queues are configured and used with JMS.
|