Queue Class Reference

Public Member Functions
	__construct (AppState $appState, LocaleResolver $localeResolver, ResourceConnection $resourceConnection, LoggerInterface $logger, DeployPackage $deployPackageService, array $options=[], $maxProcesses=self::DEFAULT_MAX_PROCESSES_AMOUNT, $maxExecTime=self::DEFAULT_MAX_EXEC_TIME)
	add (Package $package, array $dependencies=[])
	getPackages ()
	process ()
	__destruct ()

Data Fields
const	DEFAULT_MAX_PROCESSES_AMOUNT = 4
const	DEFAULT_MAX_EXEC_TIME = 400

Detailed Description

Deployment Queue

Deploy packages in parallel forks (if available)

Definition at line 20 of file Queue.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AppState	$appState,
		LocaleResolver	$localeResolver,
		ResourceConnection	$resourceConnection,
		LoggerInterface	$logger,
		DeployPackage	$deployPackageService,
		array	$options = [],
			$maxProcesses = self::DEFAULT_MAX_PROCESSES_AMOUNT,
			$maxExecTime = self::DEFAULT_MAX_EXEC_TIME
	)

Parameters

AppState	$appState
LocaleResolver	$localeResolver
ResourceConnection	$resourceConnection
LoggerInterface	$logger
DeployPackage	$deployPackageService
array	$options
int	$maxProcesses
int	$maxExecTime

Definition at line 107 of file Queue.php.

      {
        $this->appState = $appState;
        $this->localeResolver = $localeResolver;
        $this->resourceConnection = $resourceConnection;
        $this->logger = $logger;
        $this->deployPackageService = $deployPackageService;
        $this->options = $options;
        $this->maxProcesses = $maxProcesses;
        $this->maxExecTime = $maxExecTime;
    }

__destruct()

__destruct

(

)

Free resources

Protect against zombie process

Returns

void

Definition at line 362 of file Queue.php.

    {
        foreach ($this->inProgress as $package) {
            if (pcntl_waitpid($this->getPid($package), $status) === -1) {
                throw new \RuntimeException(
                    'Error while waiting for package deployed: ' . $this->getPid($package) . '; Status: ' . $status
                );
            }
        }
    }

Member Function Documentation

add()

add	(	Package	$package,
		array	$dependencies = []
	)

Parameters

Package	$package
	Package[]	$dependencies

Returns

bool true on success

Definition at line 132 of file Queue.php.

    {
        $this->packages[$package->getPath()] = [
            'package' => $package,
            'dependencies' => $dependencies
        ];

        return true;
    }

getPackages()

getPackages

(

)

Returns

Package[]

Definition at line 145 of file Queue.php.

    {
        return $this->packages;
    }

process()

process

(

)

Process jobs

Returns

int

Definition at line 155 of file Queue.php.

    {
        $returnStatus = 0;
        $this->start = $this->lastJobStarted = time();
        $packages = $this->packages;
        while (count($packages) && $this->checkTimeout()) {
            foreach ($packages as $name => $packageJob) {
                $this->assertAndExecute($name, $packages, $packageJob);
            }
            $this->logger->info('.');
            sleep(3);
            foreach ($this->inProgress as $name => $package) {
                if ($this->isDeployed($package)) {
                    unset($this->inProgress[$name]);
                }
            }
        }

        $this->awaitForAllProcesses();

        return $returnStatus;
    }

Field Documentation

DEFAULT_MAX_EXEC_TIME

const DEFAULT_MAX_EXEC_TIME = 400

Default max execution time

Definition at line 30 of file Queue.php.

DEFAULT_MAX_PROCESSES_AMOUNT

const DEFAULT_MAX_PROCESSES_AMOUNT = 4

Default max amount of processes

Definition at line 25 of file Queue.php.

---

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

• vendor/magento/module-deploy/Process/Queue.php