Abstract Class yii\queue\cli\Queue

All Classes | Properties | Methods | Events | Constants
Inheritanceyii\queue\cli\Queue » yii\queue\Queue » yii\base\Component
Implementsyii\base\BootstrapInterface
Subclassesyii\queue\amqp\Queue, yii\queue\amqp_interop\Queue, yii\queue\beanstalk\Queue, yii\queue\db\Queue, yii\queue\file\Queue, yii\queue\gearman\Queue, yii\queue\redis\Queue

Queue with CLI

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attempts integer Default attempt count yii\queue\Queue
$commandClass string Command class name yii\queue\cli\Queue
$commandOptions array Of additional options of command yii\queue\cli\Queue
$loopConfig array|string yii\queue\cli\Queue
$messageHandler callable|null yii\queue\cli\Queue
$serializer yii\queue\serializers\SerializerInterface|array yii\queue\Queue
$strictJobType boolean Whether to enable strict job type control. yii\queue\Queue
$ttr integer Default time to reserve a job yii\queue\Queue

Public Methods

Hide inherited methods

MethodDescriptionDefined By
bootstrap() yii\queue\cli\Queue
delay() Sets delay for later execute yii\queue\Queue
execute() yii\queue\cli\Queue
getWorkerPid() Gets process ID of a worker. yii\queue\cli\Queue
handleError() yii\queue\Queue
init() yii\queue\Queue
isDone() yii\queue\Queue
isReserved() yii\queue\Queue
isWaiting() yii\queue\Queue
priority() Sets job priority yii\queue\Queue
push() Pushes job into queue yii\queue\Queue
status() yii\queue\Queue
ttr() Sets TTR for job execute yii\queue\Queue

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getCommandId() yii\queue\cli\Queue
handleMessage() yii\queue\cli\Queue
pushMessage() yii\queue\Queue
runWorker() Runs worker. yii\queue\cli\Queue

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ERROR yii\queue\ExecEvent yii\queue\Queue
EVENT_AFTER_EXEC yii\queue\ExecEvent yii\queue\Queue
EVENT_AFTER_PUSH yii\queue\PushEvent yii\queue\Queue
EVENT_BEFORE_EXEC yii\queue\ExecEvent yii\queue\Queue
EVENT_BEFORE_PUSH yii\queue\PushEvent yii\queue\Queue
EVENT_WORKER_START yii\queue\cli\WorkerEvent (available since version 2.0.2) yii\queue\cli\Queue
EVENT_WORKER_STOP yii\queue\cli\WorkerEvent (available since version 2.0.2) yii\queue\cli\Queue

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
STATUS_DONE 3 yii\queue\Queue
STATUS_RESERVED 2 yii\queue\Queue
STATUS_WAITING 1 yii\queue\Queue

Property Details

$commandClass public property

Command class name

public string $commandClass = \yii\queue\cli\Command::class
$commandOptions public property

Of additional options of command

public array $commandOptions = []
$loopConfig public property (available since version 2.0.2)
public array|string $loopConfig = \yii\queue\cli\SignalLoop::class
$messageHandler public property
public callable|null $messageHandler = null

Method Details

bootstrap() public method

public void bootstrap ( $app )
$app
execute() public method

public boolean execute ( $id, $message, $ttr, $attempt, $workerPid )
$id string

Of a message
$message string
$ttr integer

Time to reserve
$attempt integer

Number
$workerPid integer

Of worker process
getCommandId() protected method

protected string getCommandId ( )
return string

Command id
throws
getWorkerPid() public method (available since version 2.0.2)

Gets process ID of a worker.

public integer getWorkerPid ( )
handleMessage() protected method

protected boolean handleMessage ( $id, $message, $ttr, $attempt )
$id string

Of a job message
$message string
$ttr integer

Time to reserve
$attempt integer

Number
runWorker() protected method (available since version 2.0.2)

Runs worker.

protected null|integer runWorker ( callable $handler )
$handler callable
return null|integer

Exit code

Event Details

EVENT_WORKER_START event of type yii\queue\cli\WorkerEvent (available since version 2.0.2)
EVENT_WORKER_STOP event of type yii\queue\cli\WorkerEvent (available since version 2.0.2)