yii\queue\sync\Queue - Yii2 类参考手册
Class yii\queue\sync\Queue
Inheritance | yii\queue\sync\Queue » yii\queue\Queue » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Sync Queue
Public Properties
隐藏继承的属性 Hide inherited 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 |
$handle | boolean | yii\queue\sync\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 |
$workerPid | null | yii\queue\Queue |
Public Methods
隐藏继承的方法 Hide inherited 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\sync\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 |
run() | Runs all jobs from queue. | yii\queue\sync\Queue |
status() | yii\queue\sync\Queue | |
trigger() | Triggers an event. | yii\base\Component |
ttr() | Sets TTR for job execute | yii\queue\Queue |
Protected Methods
隐藏继承的方法 Hide inherited methods
方法 Method | 简介 Description | 定义在 Defined By |
---|---|---|
handleMessage() | yii\queue\Queue | |
pushMessage() | yii\queue\sync\Queue |
事件 Events
常量 Constants
隐藏继承的常量 Hide inherited 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
方法详情 Method Details
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 ( ) |
protected 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 |
---|
Runs all jobs from queue.
public void run ( ) |
public integer status ( $id ) | ||
$id | string | Of a job message |
return | integer | Status code |
---|