ConsumersRunner Class Reference

Public Member Functions
	__construct (PhpExecutableFinder $phpExecutableFinder, ConsumerConfigInterface $consumerConfig, DeploymentConfig $deploymentConfig, ShellInterface $shellBackground, PidConsumerManager $pidConsumerManager, ConnectionTypeResolver $mqConnectionTypeResolver=null, LoggerInterface $logger=null)
	run ()

Data Fields
const	PID_FILE_EXT = '.pid'

Detailed Description

Class for running consumers processes by cron

Definition at line 21 of file ConsumersRunner.php.

Constructor & Destructor Documentation

__construct()

__construct	(	PhpExecutableFinder	$phpExecutableFinder,
		ConsumerConfigInterface	$consumerConfig,
		DeploymentConfig	$deploymentConfig,
		ShellInterface	$shellBackground,
		PidConsumerManager	$pidConsumerManager,
		ConnectionTypeResolver	$mqConnectionTypeResolver = null,
		LoggerInterface	$logger = null
	)

Parameters

PhpExecutableFinder	$phpExecutableFinder	The executable finder specifically designed for the PHP executable
ConsumerConfigInterface	$consumerConfig	The consumer config provider
DeploymentConfig	$deploymentConfig	The application deployment configuration
ShellInterface	$shellBackground	The shell command line wrapper for executing command in background
PidConsumerManager	$pidConsumerManager	The class for checking status of process by PID
ConnectionTypeResolver	$mqConnectionTypeResolver	Consumer connection resolver
LoggerInterface	$logger	Logger

Definition at line 83 of file ConsumersRunner.php.

      {
        $this->phpExecutableFinder = $phpExecutableFinder;
        $this->consumerConfig = $consumerConfig;
        $this->deploymentConfig = $deploymentConfig;
        $this->shellBackground = $shellBackground;
        $this->pidConsumerManager = $pidConsumerManager;
        $this->mqConnectionTypeResolver = $mqConnectionTypeResolver
            ?: ObjectManager::getInstance()->get(ConnectionTypeResolver::class);
        $this->logger = $logger
            ?: ObjectManager::getInstance()->get(LoggerInterface::class);
    }

Member Function Documentation

run()

run

(

)

Runs consumers processes

Definition at line 106 of file ConsumersRunner.php.

    {
        $runByCron = $this->deploymentConfig->get('cron_consumers_runner/cron_run', true);

        if (!$runByCron) {
            return;
        }

        $maxMessages = (int) $this->deploymentConfig->get('cron_consumers_runner/max_messages', 10000);
        $allowedConsumers = $this->deploymentConfig->get('cron_consumers_runner/consumers', []);
        $php = $this->phpExecutableFinder->find() ?: 'php';

        foreach ($this->consumerConfig->getConsumers() as $consumer) {
            if (!$this->canBeRun($consumer, $allowedConsumers)) {
                continue;
            }

            $consumerName = $consumer->getName();

            $arguments = [
                $consumerName,
                '--pid-file-path=' . $this->getPidFilePath($consumerName),
            ];

            if ($maxMessages) {
                $arguments[] = '--max-messages=' . $maxMessages;
            }

            $command = $php . ' ' . BP . '/bin/magento queue:consumers:start %s %s'
                . ($maxMessages ? ' %s' : '');

            $this->shellBackground->execute($command, $arguments);
        }
    }

Field Documentation

PID_FILE_EXT

const PID_FILE_EXT = '.pid'

Extension of PID file

Definition at line 26 of file ConsumersRunner.php.

---

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

• vendor/magento/module-message-queue/Model/Cron/ConsumersRunner.php