ConsumerRunner Class Reference

Public Member Functions
	__construct (ConsumerFactory $consumerFactory, MaintenanceMode $maintenanceMode=null, $maintenanceSleepInterval=30)
	__call ($name, $arguments)

Detailed Description

Consumer runner class is used to run consumer, which name matches the magic method invoked on this class.

Is used to schedule consumers execution in crontab.xml as follows: <job name="consumerConsumerName" instance="Magento\MessageQueue\Model\ConsumerRunner" method="consumerName"> Where consumerName should be a valid name of consumer registered in some queue.xml

@api

Since

100.0.2

Definition at line 25 of file ConsumerRunner.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ConsumerFactory	$consumerFactory,
		MaintenanceMode	$maintenanceMode = null,
			$maintenanceSleepInterval = 30
	)

Initialize dependencies.

Parameters

ConsumerFactory	$consumerFactory
MaintenanceMode	$maintenanceMode
integer	$maintenanceSleepInterval

Definition at line 49 of file ConsumerRunner.php.

      {
        $this->consumerFactory = $consumerFactory;
        $this->maintenanceMode = $maintenanceMode ?: ObjectManager::getInstance()->get(MaintenanceMode::class);
        $this->maintenanceSleepInterval = $maintenanceSleepInterval;
    }

Member Function Documentation

__call()

__call	(		$name,
			$arguments
	)

Process messages in queue using consumer, which name is equal to the current magic method name.

Parameters

string	$name
array	$arguments

Exceptions

LocalizedException

Returns

void

Definition at line 67 of file ConsumerRunner.php.

    {
        try {
            $consumer = $this->consumerFactory->get($name);
        } catch (\Exception $e) {
            $errorMsg = '"%callbackMethod" callback method specified in crontab.xml '
                . 'must have corresponding consumer declared in some queue.xml.';
            throw new LocalizedException(__($errorMsg, ['callbackMethod' => $name]));
        }
        if (!$this->maintenanceMode->isOn()) {
            $consumer->process();
        } else {
            sleep($this->maintenanceSleepInterval);
        }
    }

---

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

• vendor/magento/module-message-queue/Model/ConsumerRunner.php