Class yii\queue\amqp\Queue
| Inheritance | yii\queue\amqp\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component |
|---|---|
| Implements | yii\base\BootstrapInterface |
| Deprecated since version | since 2.0.2 and will be removed in 2.1. Consider using amqp_interop driver instead. |
Amqp Queue
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attempts | integer | Default attempt count | yii\queue\Queue |
| $commandClass | string | Command class name | yii\queue\amqp\Queue |
| $commandOptions | array | Of additional options of command | yii\queue\cli\Queue |
| $exchangeName | yii\queue\amqp\Queue | ||
| $host | yii\queue\amqp\Queue | ||
| $loopConfig | array|string | yii\queue\cli\Queue | |
| $messageHandler | callable|null | yii\queue\cli\Queue | |
| $password | yii\queue\amqp\Queue | ||
| $port | yii\queue\amqp\Queue | ||
| $queueName | yii\queue\amqp\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 |
| $user | yii\queue\amqp\Queue | ||
| $vhost | yii\queue\amqp\Queue |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $channel | \PhpAmqpLib\Channel\AMQPChannel | yii\queue\amqp\Queue | |
| $connection | \PhpAmqpLib\Connection\AMQPStreamConnection | yii\queue\amqp\Queue |
Public Methods
| Method | Description | Defined 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\amqp\Queue | |
| isDone() | yii\queue\Queue | |
| isReserved() | yii\queue\Queue | |
| isWaiting() | yii\queue\Queue | |
| listen() | Listens amqp-queue and runs new jobs. | yii\queue\amqp\Queue |
| priority() | Sets job priority | yii\queue\Queue |
| push() | Pushes job into queue | yii\queue\Queue |
| status() | yii\queue\amqp\Queue | |
| ttr() | Sets TTR for job execute | yii\queue\Queue |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| close() | Closes connection and channel | yii\queue\amqp\Queue |
| getCommandId() | yii\queue\cli\Queue | |
| handleMessage() | yii\queue\cli\Queue | |
| open() | Opens connection and channel | yii\queue\amqp\Queue |
| pushMessage() | yii\queue\amqp\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
| 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
Closes connection and channel
| protected void close ( ) |
| public void init ( ) |
Listens amqp-queue and runs new jobs.
| public void listen ( ) |
Opens connection and channel
| protected void open ( ) |
| 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 |
|---|---|---|
| public integer status ( $id ) | ||
| $id | string | Of a job message |
| return | integer | Status code |
|---|---|---|