Abstract Class yii\queue\Queue
| Inheritance | yii\queue\Queue » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\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\sqs\Queue, yii\queue\stomp\Queue, yii\queue\sync\Queue |
| Available since version | 2.0.2 |
| Source Code | https://github.com/yiisoft/yii2-queue/blob/master/Queue.php |
Base Queue.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attempts | integer | Default attempt count | yii\queue\Queue |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $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 |
| $workerPid | null|integer | yii\queue\Queue |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| delay() | Sets delay for later execute. | yii\queue\Queue |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getWorkerPid() | Uses for CLI drivers and gets process ID of a worker. | yii\queue\Queue |
| handleError() | yii\queue\Queue | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\queue\Queue |
| isDone() | yii\queue\Queue | |
| isReserved() | yii\queue\Queue | |
| isWaiting() | yii\queue\Queue | |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| priority() | Sets job priority. | yii\queue\Queue |
| push() | Pushes job into queue. | yii\queue\Queue |
| status() | yii\queue\Queue | |
| trigger() | Triggers an event. | yii\base\Component |
| ttr() | Sets TTR for job execute. | yii\queue\Queue |
| unserializeMessage() | Unserializes. | yii\queue\Queue |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| handleMessage() | yii\queue\Queue | |
| pushMessage() | yii\queue\Queue |
Events
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| STATUS_DONE | 3 | yii\queue\Queue | |
| STATUS_RESERVED | 2 | yii\queue\Queue | |
| STATUS_WAITING | 1 | yii\queue\Queue |
Property Details
Default attempt count
public yii\queue\serializers\SerializerInterface|array $serializer = \yii\queue\serializers\PhpSerializer::class
Whether to enable strict job type control. Note that in order to enable type control, a pushing job must be yii\queue\JobInterface instance.
Default time to reserve a job
Method Details
Sets delay for later execute.
| public $this delay ( $value ) | ||
| $value | integer|mixed | |
Uses for CLI drivers and gets process ID of a worker.
| public void getWorkerPid ( ) |
| public boolean handleError ( yii\queue\ExecEvent $event ) | ||
| $event | yii\queue\ExecEvent | |
| protected boolean handleMessage ( $id, $message, $ttr, $attempt ) | ||
| $id | string | Of a job message |
| $message | string | |
| $ttr | integer | Time to reserve |
| $attempt | integer | Number |
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
| public boolean isDone ( $id ) | ||
| $id | string | Of a job message |
| public boolean isReserved ( $id ) | ||
| $id | string | Of a job message |
| public boolean isWaiting ( $id ) | ||
| $id | string | Of a job message |
Sets job priority.
| public $this priority ( $value ) | ||
| $value | mixed | |
Pushes job into queue.
| public string|null push ( $job ) | ||
| $job | yii\queue\JobInterface|mixed | |
| return | string|null | Id of a job message |
|---|---|---|
| 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 |
|---|---|---|
| public abstract integer status ( $id ) | ||
| $id | string | Of a job message |
| return | integer | Status code |
|---|---|---|
Sets TTR for job execute.
| public $this ttr ( $value ) | ||
| $value | integer|mixed | |
Unserializes.
| public array unserializeMessage ( $serialized ) | ||
| $serialized | string | Message |
| return | array | Pair of a job and error that |
|---|---|---|