yii\queue\redis\Queue - Yii2 类参考手册
Class yii\queue\redis\Queue
Inheritance | yii\queue\redis\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\BootstrapInterface, yii\base\Configurable |
Redis 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 |
$channel | string | yii\queue\redis\Queue | |
$commandClass | string | Command class name | yii\queue\redis\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 | |
$redis | yii\redis\Connection|array|string | yii\queue\redis\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 | integer | yii\queue\cli\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 |
bootstrap() | Bootstrap method to be called during application bootstrap stage. | yii\queue\cli\Queue |
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 |
clear() | Clears the queue | yii\queue\redis\Queue |
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 |
execute() | yii\queue\cli\Queue | |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getWorkerPid() | Gets process ID of a worker. | yii\queue\cli\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\redis\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 |
remove() | Removes a job by ID | yii\queue\redis\Queue |
run() | Listens queue and runs each job. | yii\queue\redis\Queue |
status() | yii\queue\redis\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 |
---|---|---|
closeWorker() | yii\queue\redis\Queue | |
delete() | Deletes message by ID | yii\queue\redis\Queue |
getCommandId() | yii\queue\cli\Queue | |
handleMessage() | yii\queue\cli\Queue | |
moveExpired() | yii\queue\redis\Queue | |
openWorker() | yii\queue\redis\Queue | |
pushMessage() | yii\queue\redis\Queue | |
reserve() | yii\queue\redis\Queue | |
runWorker() | Runs worker. | yii\queue\cli\Queue |
事件 Events
事件 Event | 类型 Type | 简介 Description | 定义在 Defined 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
常量 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
Command class name
方法详情 Method Details
Clears the queue
public void clear ( ) |
protected void closeWorker ( ) |
Deletes message by ID
protected void delete ( $id ) | ||
$id | integer | Of a message |
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 void moveExpired ( $from ) | ||
$from | string |
protected void openWorker ( ) |
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 |
---|
Removes a job by ID
public boolean remove ( $id ) | ||
$id | integer | Of a job |
protected array|null reserve ( $timeout ) | ||
$timeout | integer | Timeout |
return | array|null | Payload |
---|
Listens queue and runs each job.
public null|integer run ( $repeat, $timeout = 0 ) | ||
$repeat | boolean | Whether to continue listening when queue is empty. |
$timeout | integer | Number of seconds to wait for next message. |
return | null|integer | Exit code. |
---|
public integer status ( $id ) | ||
$id | string | Of a job message |
return | integer | Status code |
---|