Delivering Scheduled Messages

Notes and Constraints

• This function is supported only for instances created on or after March 30, 2022.
• To receive and send scheduled messages, ensure the topic message type is Scheduled before connecting a client to a RocketMQ instance of version 5.x.

Application Scenarios

Scheduled messages can be used in the following scenarios:

• The service logic requires a time window. For example, an e-commerce order is closed if it is not paid within a period of time. When an order is created, a scheduled message is sent and will be delivered to the consumer five minutes later. After receiving the message, the consumer checks whether the order is paid. If the order is not paid, it is closed. If the order is paid, the message is ignored.
• A scheduled task is triggered by a message. For example, a reminder is sent to a user at a specific time.

Note

• The delivery time can be scheduled to up to one year later. If the delay time exceeds one year, the message cannot be delivered.
• If the delivery time is scheduled to a time point earlier than the current timestamp, the message is immediately sent to the consumer.
• Ideally, the difference between the scheduled delivery time and the actual delivery time is smaller than 0.1s. However, if the pressure of scheduled message delivery is too high, flow control will be triggered, and the precision will deteriorate.
• The message delivery order is not ensured for precision of 0.1s. That is, if the difference between the scheduled delivery time of two messages is smaller than 0.1s, they may not be delivered in the order that they were sent.
• Exactly-once delivery is not guaranteed. A scheduled message may be delivered repeatedly.
• The scheduled time is the time when the server starts to deliver a message to a consumer. If messages are stacked on the consumer, the scheduled message is delivered after the stacked messages, and cannot be delivered exactly at the configured time.
• Due to a potential time difference between the client and server, the actual delivery time may be different from the delivery time set by the client. The server time is used.
• Messages are retained for a period (two days by default) after the scheduled delivery time. For example, if a scheduled message is not consumed in five days as scheduled, it is deleted on the seventh day.
• Scheduled messages occupy about three times the storage space of normal messages. If you use a large number of scheduled messages, pay attention to the storage space usage.

Preparing the Environment

1. Run the python command to check whether Python has been installed. If the following information is displayed, Python has been installed:

   Python 3.7.1 (default, Jul  5 2020, 14:37:24) 
   [GCC 4.8.5 20150623 (Red Hat 4.8.5-39)] on linux
   Type "help", "copyright", "credits" or "license" for more information.
   >>>

   If Python is not installed, run the following command:

   yum install python

2. Install the librocketmq library and rocketmq-client-python. For details, see rocketmq-client-python.
   

   Download rocketmq-client-cpp-2.2.0 to obtain the librocketmq library.

3. Add librocketmq.so to the system's dynamic library search path.
   1. Find the path of librocketmq.so.

      find / -name librocketmq.so

   2. Add librocketmq.so to the system's dynamic library search path.

      ln -s /librocketmq.so_path/librocketmq.so /usr/lib
      sudo ldconfig

Delivering Scheduled Messages

The following code is an example. Replace the information in bold with the actual values.

import time

from rocketmq.client import Producer, Message

topic = 'TopicTest'
gid = 'test'
name_srv = '192.168.0.1:8100'


def create_message():
    msg = Message(topic)
    msg.set_keys('XXX')
    msg.set_tags('XXX')
    msg.set_property('property', 'test')
    msg.set_body('message body')
    return msg


def send_delay_message():
    producer = Producer(gid)
    producer.set_name_server_address(name_srv)
    producer.start()
    msg = create_message()
    msg.set_property('__STARTDELIVERTIME', str(int(round((time.time() + 3) * 1000))))
    ret = producer.send_sync(msg)
    print('send message status: ' + str(ret.status) + ' msgId: ' + ret.msg_id)
    producer.shutdown()


if __name__ == '__main__':
    send_delay_message()

The parameters in the example code are described as follows. For details about how to obtain the parameter values, see Collecting Connection Information.

• topic: topic name.
• gid: producer group name. Enter a name as required.
• name_srv: instance address and port.