Consumer Class Reference

Inheritance diagram for Consumer:

Data Structures
class	ConfigTest
class	DeprecatedConfigTest

Public Member Functions
	__construct (CallbackInvoker $invoker, MessageEncoder $messageEncoder, ResourceConnection $resource, ConsumerConfigurationInterface $configuration, LoggerInterface $logger=null)
	process ($maxNumberOfMessages=null)

Detailed Description

Class Consumer used to process a single message, unlike batch consumer.

This could be used for both synchronous and asynchronous processing, depending on topic.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file Consumer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CallbackInvoker	$invoker,
		MessageEncoder	$messageEncoder,
		ResourceConnection	$resource,
		ConsumerConfigurationInterface	$configuration,
		LoggerInterface	$logger = null
	)

Initialize dependencies.

Parameters

CallbackInvoker	$invoker
MessageEncoder	$messageEncoder
ResourceConnection	$resource
ConsumerConfigurationInterface	$configuration
LoggerInterface	$logger	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 91 of file Consumer.php.

      {
        $this->invoker = $invoker;
        $this->messageEncoder = $messageEncoder;
        $this->resource = $resource;
        $this->configuration = $configuration;
        $this->logger = $logger ?: \Magento\Framework\App\ObjectManager::getInstance()->get(LoggerInterface::class);
    }

Member Function Documentation

process()

process

(

$maxNumberOfMessages = null

)

{Connects to a queue, consumes a message on the queue, and invoke a method to process the message contents.

Parameters

int | null

$maxNumberOfMessages

if not specified - process all queued incoming messages and terminate, otherwise terminate execution after processing the specified number of messages

Returns

void

}

Implements ConsumerInterface.

Definition at line 108 of file Consumer.php.

    {
        $queue = $this->configuration->getQueue();

        if (!isset($maxNumberOfMessages)) {
            $queue->subscribe($this->getTransactionCallback($queue));
        } else {
            $this->invoker->invoke($queue, $maxNumberOfMessages, $this->getTransactionCallback($queue));
        }
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework-message-queue/Consumer.php