mirror of
https://github.com/apache/activemq-artemis.git
synced 2025-02-07 18:49:14 +00:00
2b5d8f3b80
- Split protocols into individual chapters - Reorganize summary to flow more logically - Fill in missing parameters in configuration index - Normalize spaces for ordered and unordered lists - Re-wrap lots of text for readability - Fix incorrect XML snippets - Normalize table formatting - Improve internal links with anchors - Update content to reflect new address model - Resized architecture images to avoid excessive white-space - Update some JavaDoc - Update some schema elements - Disambiguate AIO & ASYNCIO where necessary - Use URIs instead of Objects in code examples
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# Scheduled Messages
|
|
|
|
Scheduled messages differ from normal messages in that they won't be
|
|
delivered until a specified time in the future, at the earliest.
|
|
|
|
To do this, a special property is set on the message before sending it.
|
|
|
|
## Scheduled Delivery Property
|
|
|
|
The property name used to identify a scheduled message is
|
|
`"_AMQ_SCHED_DELIVERY"` (or the constant
|
|
`Message.HDR_SCHEDULED_DELIVERY_TIME`).
|
|
|
|
The specified value must be a positive `long` corresponding to the time
|
|
the message must be delivered (in milliseconds). An example of sending a
|
|
scheduled message using the JMS API is as follows.
|
|
|
|
```java
|
|
TextMessage message = session.createTextMessage("This is a scheduled message message which will be delivered in 5 sec.");
|
|
message.setLongProperty("_AMQ_SCHED_DELIVERY", System.currentTimeMillis() + 5000);
|
|
producer.send(message);
|
|
|
|
...
|
|
|
|
// message will not be received immediately but 5 seconds later
|
|
TextMessage messageReceived = (TextMessage) consumer.receive();
|
|
```
|
|
Scheduled messages can also be sent using the core API, by setting the
|
|
same property on the core message before sending.
|
|
|
|
## Example
|
|
|
|
See the [Scheduled Message Example](examples.md#scheduled-message) which shows how scheduled messages can be used with
|
|
JMS.
|