KMP PHP API Reference

QueueDrainService
in package

Runs bounded queue workers against the current default datasource.

Table of Contents

Constants

DEFAULT_MAX_JOBS  : mixed = 25
DEFAULT_MAX_RUNTIME_SECONDS  : mixed = 45
MAX_JOBS  : mixed = 100
MAX_RUNTIME_SECONDS  : mixed = 55

Properties

$container  : ContainerInterface
$processorFactory  : Closure

Methods

__construct()  : mixed
drainDefault()  : int
Drain due jobs from the application's default datasource.
drainTenant()  : int
Drain due jobs from the active tenant datasource.
drain()  : int
Drain the datasource currently aliased as `default`.

Constants

Properties

Methods

__construct()

public __construct(ContainerInterface $container[, Closure|null $processorFactory = null ]) : mixed
Parameters
$container : ContainerInterface

Application service container

$processorFactory : Closure|null = null

Optional processor factory for tests

drainDefault()

Drain due jobs from the application's default datasource.

public drainDefault([int $maxJobs = self::DEFAULT_MAX_JOBS ][, int $maxRuntimeSeconds = self::DEFAULT_MAX_RUNTIME_SECONDS ]) : int
Parameters
$maxJobs : int = self::DEFAULT_MAX_JOBS
$maxRuntimeSeconds : int = self::DEFAULT_MAX_RUNTIME_SECONDS
Return values
int

drainTenant()

Drain due jobs from the active tenant datasource.

public drainTenant([int $maxJobs = self::DEFAULT_MAX_JOBS ][, int $maxRuntimeSeconds = self::DEFAULT_MAX_RUNTIME_SECONDS ]) : int
Parameters
$maxJobs : int = self::DEFAULT_MAX_JOBS
$maxRuntimeSeconds : int = self::DEFAULT_MAX_RUNTIME_SECONDS
Return values
int

drain()

Drain the datasource currently aliased as `default`.

private drain(string $queueName, int $maxJobs, int $maxRuntimeSeconds) : int
Parameters
$queueName : string
$maxJobs : int
$maxRuntimeSeconds : int
Return values
int
On this page

Search results