Abstract Class yii\queue\Queue

All Classes | Properties | Methods | Events | Constants
Inheritanceyii\queue\Queue » yii\base\Component
Subclassesyii\queue\amqp\Queue, yii\queue\amqp_interop\Queue, yii\queue\beanstalk\Queue, yii\queue\cli\Queue, yii\queue\db\Queue, yii\queue\file\Queue, yii\queue\gearman\Queue, yii\queue\redis\Queue, yii\queue\sync\Queue
Available since version2.0.2

Base Queue

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attempts integer Default attempt count yii\queue\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
delay() Sets delay for later execute yii\queue\Queue
getWorkerPid() Uses for CLI drivers and gets process ID of a worker. yii\queue\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
handleMessage() yii\queue\Queue
pushMessage() yii\queue\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

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

$attempts public property

Default attempt count

public integer $attempts = 1
$serializer public property
public yii\queue\serializers\SerializerInterface|array $serializer = \yii\queue\serializers\PhpSerializer::class
$strictJobType public property (available since version 2.0.1)

Whether to enable strict job type control. Note that in order to enable type control, a pushing job must be yii\queue\JobInterface instance.

public boolean $strictJobType = true
$ttr public property

Default time to reserve a job

public integer $ttr = 300

Method Details

delay() public method

Sets delay for later execute

public $this delay ( $value )
$value integer|mixed
getWorkerPid() public method (available since version 2.0.2)

Uses for CLI drivers and gets process ID of a worker.

public null getWorkerPid ( )
handleError() public method

public boolean handleError ( $id, $job, $ttr, $attempt, $error )
$id string|null
$job yii\queue\JobInterface
$ttr integer
$attempt integer
$error Exception|Throwable
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
init() public method

public void init ( )
isDone() public method

public boolean isDone ( $id )
$id string

Of a job message
isReserved() public method

public boolean isReserved ( $id )
$id string

Of a job message
isWaiting() public method

public boolean isWaiting ( $id )
$id string

Of a job message
priority() public method

Sets job priority

public $this priority ( $value )
$value mixed
push() public method

Pushes job into queue

public string|null push ( $job )
$job yii\queue\JobInterface|mixed
return string|null

Id of a job message
pushMessage() protected abstract method

protected abstract string pushMessage ( $message, $ttr, $delay, $priority )
$message string
$ttr integer

Time to reserve in seconds
$delay integer
$priority mixed
return string

Id of a job message
status() public abstract method

public abstract integer status ( $id )
$id string

Of a job message
return integer

Status code
ttr() public method

Sets TTR for job execute

public $this ttr ( $value )
$value integer|mixed

Event Details

EVENT_AFTER_ERROR event of type yii\queue\ExecEvent
EVENT_AFTER_EXEC event of type yii\queue\ExecEvent
EVENT_AFTER_PUSH event of type yii\queue\PushEvent
EVENT_BEFORE_EXEC event of type yii\queue\ExecEvent
EVENT_BEFORE_PUSH event of type yii\queue\PushEvent