RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

mixed

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

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

from Queue

mixed

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

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

from Queue

mixed

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

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

from Queue

string

createPayload(string $job, mixed $data = '')

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

from Queue

array

createPayloadArray(string $job, mixed $data = '')

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

array

createObjectPayload(mixed $job)

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

from Queue

string

getDisplayName(mixed $job)

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

from Queue

mixed

getJobExpiration(mixed $job)

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

from Queue

array

createStringPayload(string $job, mixed $data)

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

from Queue

string

getConnectionName()

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

from Queue

$this

setConnectionName(string $name)

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

from Queue

void

setContainer(Container $container)

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

from Queue

void

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

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

int

size(string $queue = null)

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

mixed

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

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

mixed

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

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

mixed

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

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

mixed

laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string $queue = null)

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

Job|null

pop(string $queue = null)

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

void

migrate(string $queue)

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

array

migrateExpiredJobs(string $from, string $to)

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

array

retrieveNextJob(string $queue)

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

array

blockingPop(string $queue)

Извлечь следующую задачу с помощью блокирующего извлечения.

void

deleteReserved(string $queue, RedisJob $job)

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

void

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

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

string

getRandomId()

Получить случайную строку ID.

string

getQueue(string|null $queue)

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

Connection

getConnection()

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

Factory

getRedis()

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

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

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

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

Параметры

string	$queue
string	$job
mixed	$data

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

mixed

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

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

Параметры

string	$queue
DateTimeInterface\|DateInterval\|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	$job
mixed	$data

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

string

Исключения

InvalidPayloadException

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

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

Параметры

string	$job
mixed	$data

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

array

protected array createObjectPayload(mixed $job)

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

Параметры

mixed

$job

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

array

protected string getDisplayName(mixed $job)

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

Параметры

mixed

$job

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

string

mixed getJobExpiration(mixed $job)

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

Параметры

mixed

$job

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

mixed

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, int|null $blockFor = null)

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

Параметры

Factory	$redis
string	$default
string	$connection
int	$retryAfter
int\|null	$blockFor

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

void

int size(string $queue = null)

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

Параметры

string

$queue

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

int

END_OF_DOCUMENT_MARKER

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

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

Parameters

string\|object	$job
mixed	$data
string	$queue

Return Value

mixed

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

Отправить сырое содержимое в очередь.

Parameters

string	$payload
string	$queue
array	$options

Return Value

mixed

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

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

Parameters

DateTimeInterface\|DateInterval\|int	$delay
string\|object	$job
mixed	$data
string	$queue

Return Value

mixed

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

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

Parameters

DateTimeInterface\|DateInterval\|int	$delay
string	$payload
string	$queue

Return Value

mixed

Задача|null pop(string $queue = null)

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

Parameters

string

$queue

Return Value

Задача|null

protected void migrate(string $queue)

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

Parameters

string

$queue

Return Value

void

array migrateExpiredJobs(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

array

protected array retrieveNextJob(string $queue)

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

Parameters

string

$queue

Return Value

array

protected array blockingPop(string $queue)

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

Parameters

string

$queue

Return Value

array

void deleteReserved(string $queue, RedisJob $job)

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

Parameters

string	$queue
RedisJob	$job

Return Value

void

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

Удалить зарезервированную задачу из очереди резервирования и выпустить её.

Parameters

string	$queue
RedisJob	$job
int	$delay

Return Value

void

protected string getRandomId()

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

Return Value

string

string getQueue(string|null $queue)

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

Parameters

string|null

$queue

Return Value

string

protected Подключение getConnection()

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

Return Value

Подключение

Фабрика getRedis()

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

Return Value

Фабрика

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