quick_tour.md

Supporting Enqueue

Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:

• Become a sponsor
• Become our client

---

Magento2 EnqueueModule

The module integrates Enqueue Client with Magento2. You can send and consume messages to different message queues such as RabbitMQ, AMQP, STOMP, Amazon SQS, Kafka, Redis, Google PubSub, Gearman, Beanstalk, Google PubSub and others. Or integrate Magento2 app with other applications or service via Message Bus. There is a module for Magento1 too.

Installation

We recommend using composer to install magento2-enqueue module. To install libraries run the commands in the application root directory.

composer require "enqueue/magento2-enqueue:*@dev" "enqueue/amqp-ext"

Run setup:upgrade so Magento2 picks up the installed module.

php bin/magento setup:upgrade 

Configuration

At this stage we have configure the Enqueue extension in Magento backend. The config is here: Stores -> Configuration -> General -> Enqueue Message Queue. Here's the example of Amqp transport that connects to RabbitMQ broker on localhost:

Publish Message

To send a message you have to take enqueue helper and call send method.

<?php

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$enqueueManager = $objectManager->create('Enqueue\Magento2\Model\EnqueueManager');
$enqueueManager->sendEvent('a_topic', 'aMessage');

// or a command with a possible reply
$reply = $enqueueManager->sendCommand('a_topic', 'aMessage', true);

$replyMessage = $reply->receive(5000); // wait for 5 sec

Message Consumption

I assume you have acme Magento module properly created, configured and registered. To consume messages you have to define a processor class first:

<?php
// app/code/Acme/Module/Helper/Async/Foo.php

namespace Acme\Module\Helper\Async;

use Interop\Queue\Context;
use Interop\Queue\Message;
use Interop\Queue\Processor;

class Foo implements Processor
{
    public function process(Message $message, Context $context)
    {
        // do job
        // $message->getBody() -> 'payload'

        return self::ACK;         // acknowledge message
        // return self::REJECT;   // reject message
        // return self::REQUEUE;  // requeue message
    }
}

than subscribe it to a topic or several topics:

<!-- app/etc/local.xml -->

<config>
  <default>
    <enqueue>
      <processors>
        <foo-processor>
          <topic>a_topic</topic>
          <helper>acme/async_foo</helper>
        </foo-processor>
      </processors>
    </enqueue>
  </default>
</config>

and run message consume command:

$ php bin/magento enqueue:consume -vvv --setup-broker

back to index