Spec-Zone.ru › Laravel 5.4

RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Свойства

InteractsWithTime

Свойства

protected Container $container Экземпляр контейнера IoC. из Queue
protected Encrypter $encrypter Реализация шифрования. из Queue
protected string $connectionName Имя соединения для очереди. из Queue
protected Factory $redis Реализация фабрики Redis.
protected string $connection Имя соединения.
protected string $default Имя очереди по умолчанию.
protected int|null $retryAfter Время ожидания повторной попытки выполнения задания.

Методы

int secondsUntil(DateTimeInterface $delay)

Получить количество секунд до заданной даты и времени.

из InteractsWithTime
int availableAt(DateTimeInterface|int $delay)

Получить отметку времени "доступно в" в формате Unix Timestamp.

из InteractsWithTime
int currentTime()

Получить текущее время системы в формате Unix Timestamp.

из InteractsWithTime
mixed pushOn(string $queue, string $job, mixed $data = '')

Добавить новое задание в очередь.

из Queue
mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Добавить новое задание в очередь с задержкой.

из Queue
mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Добавить массив заданий в очередь.

из Queue
string createPayload(string $job, mixed $data = '', string $queue = null)

Создать строку полезной нагрузки из заданий и данных.

из Queue
array createPayloadArray(string $job, mixed $data = '', string $queue = null)

Создать массив полезной нагрузки из заданий и данных.

array createObjectPayload(mixed $job)

Создать полезную нагрузку для обработчика очереди на основе объектов.

из Queue
string getDisplayName(mixed $job)

Получить отображаемое имя для заданий.

из Queue
array createStringPayload(string $job, mixed $data)

Создать массив полезной нагрузки для очереди на основе строк.

из Queue
string getConnectionName()

Получить имя соединения для очереди.

из Queue
$this setConnectionName(string $name)

Установить имя соединения для очереди.

из Queue
void setContainer(Container $container)

Установить экземпляр контейнера IoC.

из Queue
void __construct(Factory $redis, string $default = 'default', string $connection = null, int $retryAfter = 60)

Создать новый экземпляр очереди Redis.

int size(string $queue = null)

Получить размер очереди.

mixed push(string $job, mixed $data = '', string $queue = null)

Добавить новое задание в очередь.

Подробности

protected int secondsUntil(DateTimeInterface $delay)

Получить количество секунд до указанной даты и времени.

Параметры

DateTimeInterface $delay

Возвращаемое значение

int

protected int availableAt(DateTimeInterface|int $delay)

Получить метку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|int $delay

Возвращаемое значение

int

protected int currentTime()

Получить текущее системное время в формате UNIX.

Возвращаемое значение

int

mixed pushOn(string $queue, string $job, mixed $data = '')

Добавить новую задачу в очередь.

Параметры

string $queue
string $job
mixed $data

Возвращаемое значение

mixed

mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Добавить новую задачу в очередь с отложенным выполнением.

Параметры

string $queue
DateTime|int $delay
string $job
mixed $data

Возвращаемое значение

mixed

mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Добавить массив задач в очередь.

Параметры

array $jobs
mixed $data
string $queue

Возвращаемое значение

mixed

protected string createPayload(string $job, mixed $data = '', string $queue = null)

Создать строку полезной нагрузки из заданной задачи и данных.

Параметры

string $job
mixed $data
string $queue

Возвращаемое значение

string

Исключения

InvalidPayloadException

protected array createPayloadArray(string $job, mixed $data = '', string $queue = null)

Создать строку полезной нагрузки из заданной задачи и данных.

Параметры

string $job
mixed $data
string $queue

Возвращаемое значение

array

protected array createObjectPayload(mixed $job)

Создать полезную нагрузку для обработчика очереди на основе объектов.

Параметры

mixed $job

Возвращаемое значение

array

protected string getDisplayName(mixed $job)

Получить отображаемое имя для заданной задачи.

Параметры

mixed $job

Возвращаемое значение

string

protected array createStringPayload(string $job, mixed $data)

Создать массив типичной полезной нагрузки на основе строк.

Параметры

string $job
mixed $data

Возвращаемое значение

array

string getConnectionName()

Получить имя подключения к очереди.

Возвращаемое значение

string

$this setConnectionName(string $name)

Установить имя подключения к очереди.

Параметры

string $name

Возвращаемое значение

$this

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Параметры

Container $container

Возвращаемое значение

void

void __construct(Factory $redis, string $default = 'default', string $connection = null, int $retryAfter = 60)

Создать новый экземпляр очереди Redis.

Параметры

Factory $redis
string $default
string $connection
int $retryAfter

Возвращаемое значение

void

int size(string $queue = null)

Получить размер очереди.

Параметры

string $queue

Возвращаемое значение

int

mixed push(string $job, mixed $data = '', string $queue = null)

Добавить новую задачу в очередь.

Параметры

string $job
mixed $data
string $queue

Возвращаемое значение

mixed

mixed pushRaw(string $payload, string $queue = null, array $options = [])

Добавить сырую полезную нагрузку в очередь.

Параметры

string $payload
string $queue
array $options

Возвращаемое значение

mixed

mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Добавить новую задачу в очередь с отложенным выполнением.

Параметры

DateTime|int $delay
string $job
mixed $data
string $queue

Возвращаемое значение

mixed

protected mixed laterRaw(DateTime|int $delay, string $payload, string $queue = null)

Отправить сырую задачу в очередь после задержки.

Параметры

DateTime|int $delay
string $payload
string $queue

Возвращаемое значение

mixed

Job|null pop(string $queue = null)

Извлечь следующую задачу из очереди.

Параметры

string $queue

Возвращаемое значение

Job|null

protected void migrate(string $queue)

Мигрировать любые отложенные или истекшие задачи в основную очередь.

Параметры

string $queue

Возвращаемое значение

void

array migrateExpiredJobs(string $from, string $to)

Мигрировать отложенные задачи, готовые к выполнению, в обычную очередь.

Параметры

string $from
string $to

Возвращаемое значение

array

protected array retrieveNextJob(string $queue)

Получить следующую задачу из очереди.

Параметры

string $queue

Возвращаемое значение

array

void deleteReserved(string $queue, RedisJob $job)

Удалить зарезервированную задачу из очереди.

Параметры

string $queue
RedisJob $job

Возвращаемое значение

void

void deleteAndRelease(string $queue, RedisJob $job, int $delay)

Удалить зарезервированную задачу из очереди и освободить ее.

Параметры

string $queue
RedisJob $job
int $delay

Возвращаемое значение

void

protected string getRandomId()

Получить случайный строковый идентификатор.

Возвращаемое значение

string

protected string getQueue(string|null $queue)

Получить очередь или вернуть значение по умолчанию.

Параметры

string|null $queue

Возвращаемое значение

string

protected ClientInterface getConnection()

Получить соединение для очереди.

Возвращаемое значение

ClientInterface

Factory getRedis()

Получить базовый экземпляр Redis.

Возвращаемое значение

Factory

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Queue/RedisQueue.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API