This topic provides the sample code about how to send and subscribe to scheduled messages and delayed messages by using HTTP client SDK for PHP.

Background information

  • Delayed messages: A producer sends a message to the Message Queue for Apache RocketMQ broker and expects the message to be delivered to a consumer after a specified period of time. The message is a delayed message.
  • Scheduled messages: A producer sends a message to the Message Queue for Apache RocketMQ broker and expects the message to be delivered to a consumer at a specified point in time in the future. The message is a scheduled message.
The code configurations of scheduled messages and delayed messages are the same. In essence, they are delivered to consumers after a specified period of time based on the attributes in the messages.

For more information, see Scheduled messages and delayed messages.

Prerequisites

Before you begin, make sure that the following operations are complete:

  • SDK for PHP is installed. For more information, see Prepare the environment.
  • Resources are created. The resources that you want to specify in the code are created in advance. For example, the instance, topic, and group ID that you want to specify in the code are created in the Message Queue for Apache RocketMQ console in advance. For more information, see Create resources.

Send scheduled messages or delayed messages

The following sample code provides an example on how to send scheduled messages or delayed messages:

<?php

require "vendor/autoload.php";

use MQ\Model\TopicMessage;
use MQ\MQClient;

class ProducerTest
{
    private $client;
    private $producer;

    public function __construct()
    {
        $this->client = new MQClient(
            // The HTTP endpoint. To obtain the HTTP endpoint, log on to the Message Queue for Apache RocketMQ console. In the left-side navigation pane, click Instances. On the Instances page, click the name of your instance. On the Instance Details page, scroll to the Basic Information section and view the endpoint on the Endpoints tab. 
            "${HTTP_ENDPOINT}",
            // The AccessKey ID that you created in the Resource Access Management (RAM) console for identity authentication. 
            "${ACCESS_KEY}",
            // The AccessKey secret that you created in the RAM console for identity authentication. 
            "${SECRET_KEY}"
        );

        // The topic of the message. The topic must have been created in the Message Queue for Apache RocketMQ console. 
        $topic = "${TOPIC}";
        // The ID of the instance to which the topic belongs. The instance must have been created in the Message Queue for Apache RocketMQ console. 
        // If the instance has a namespace, the instance ID must be passed in. If the instance does not have a namespace, pass in null or an empty string. Check whether your instance has a namespace on the Instance Details page in the Message Queue for Apache RocketMQ console.
        $instanceId = "${INSTANCE_ID}";

        $this->producer = $this->client->getProducer($instanceId, $topic);
    }

    public function run()
    {
        try
        {
            for ($i=1; $i<=4; $i++)
            {
                $publishMessage = new TopicMessage(
                    "hello mq!"// The content of the message. 
                );
                // The custom attributes of the message. 
                $publishMessage->putProperty("a", $i);
                // The key of the message. 
                $publishMessage->setMessageKey("MessageKey");
                // The period of time after which the broker delivers the message. In this example, the broker will deliver the message to the consumer 10 seconds later. The parameter value is a timestamp in milliseconds. 
                // If the producer sends a scheduled message, set the parameter value to the time difference between the scheduled time and the current time. 
                $publishMessage->setStartDeliverTime(time() * 1000 + 20 * 1000);
                

                $result = $this->producer->publishMessage($publishMessage);

                print "Send mq message success. msgId is:" . $result->getMessageId() . ", bodyMD5 is:" . $result->getMessageBodyMD5() . "\n";
            }
        } catch (\Exception $e) {
            print_r($e->getMessage() . "\n");
        }
    }
}


$instance = new ProducerTest();
$instance->run();

?>

            

Subscribe to scheduled messages or delayed messages

The following sample code provides an example on how to subscribe to scheduled messages or delayed messages:

<?php

require "vendor/autoload.php";

use MQ\Model\TopicMessage;
use MQ\MQClient;

class ConsumerTest
{
    private $client;
    private $producer;

    public function __construct()
    {
        $this->client = new MQClient(
            // The HTTP endpoint. To obtain the HTTP endpoint, log on to the Message Queue for Apache RocketMQ console. In the left-side navigation pane, click Instances. On the Instances page, click the name of your instance. On the Instance Details page, scroll to the Basic Information section and view the endpoint on the Endpoints tab. 
            "${HTTP_ENDPOINT}",
            // The AccessKey ID that you created in the RAM console for identity authentication. 
            "${ACCESS_KEY}",
            // The AccessKey secret that you created in the RAM console for identity authentication. 
            "${SECRET_KEY}"
        );

        // The topic of the message. The topic must have been created in the Message Queue for Apache RocketMQ console. 
        $topic = "${TOPIC}";
        // The group ID that you created in the Message Queue for Apache RocketMQ console. 
        $groupId = "${GROUP_ID}";
        // The ID of the instance to which the topic belongs. The instance must have been created in the Message Queue for Apache RocketMQ console. 
        // If the instance has a namespace, the instance ID must be passed in. If the instance does not have a namespace, pass in null or an empty string. Check whether your instance has a namespace on the Instance Details page in the Message Queue for Apache RocketMQ console.
        $instanceId = "${INSTANCE_ID}";

        $this->consumer = $this->client->getConsumer($instanceId, $topic, $groupId);
    }

    public function run()
    {
        // Cyclically consume messages in the current thread. We recommend that you use multiple threads to concurrently consume messages. 
        while (True) {
            try {
                // Consume messages in long polling mode. 
                // In long polling mode, if no message in the topic is available for consumption, the request is suspended on the broker for a specified period of time. If a message is available for consumption within the duration, a response is immediately sent to the consumer. In this example, the duration is 3 seconds. 
                $messages = $this->consumer->consumeMessage(
                    3, // The maximum number of messages that can be consumed at a time. In this example, the value is set to 3. The largest value you can set is 16. 
                    3  // The duration of a long polling cycle. Unit: seconds. In this example, the value is set to 3. The largest value you can set is 30. 
                );
            } catch (\Exception $e) {
                if ($e instanceof MQ\Exception\MessageNotExistException) {
                    // If no messages in the topic are available for consumption, the consumer requests the broker in long polling mode. 
                    printf("No message, contine long polling!RequestId:%s\n", $e->getRequestId());
                    continue;
                }

                print_r($e->getMessage() . "\n");

                sleep(3);
                continue;
            }

            print "consume finish, messages:\n";

            // Specify the business processing logic. 
            $receiptHandles = array();
            foreach ($messages as $message) {
                $receiptHandles[] = $message->getReceiptHandle();
                printf("MessageID:%s TAG:%s BODY:%s \nPublishTime:%d, FirstConsumeTime:%d, \nConsumedTimes:%d, NextConsumeTime:%d,MessageKey:%s\n",
                    $message->getMessageId(), $message->getMessageTag(), $message->getMessageBody(),
                    $message->getPublishTime(), $message->getFirstConsumeTime(), $message->getConsumedTimes(), $message->getNextConsumeTime(),
                    $message->getMessageKey());
                print_r($message->getProperties());
            }

            // If the broker does not receive an acknowledgment (ACK) from the consumer before the period of time specified in $message->getNextConsumeTime() elapses, the message will be consumed again. 
            // A unique timestamp is specified for the handle of a message each time the message is consumed. 
            print_r($receiptHandles);
            try {
                $this->consumer->ackMessage($receiptHandles);
            } catch (\Exception $e) {
                if ($e instanceof MQ\Exception\AckMessageException) {
                    // The broker may fail to receive an ACK for a message from the consumer if the handle of the message times out. 
                    printf("Ack Error, RequestId:%s\n", $e->getRequestId());
                    foreach ($e->getAckMessageErrorItems() as $errorItem) {
                        printf("\tReceiptHandle:%s, ErrorCode:%s, ErrorMsg:%s\n", $errorItem->getReceiptHandle(), $errorItem->getErrorCode(), $errorItem->getErrorCode());
                    }
                }
            }
            print "ack finish\n";


        }

    }
}


$instance = new ConsumerTest();
$instance->run();

?>