RedisQueue

class RedisQueue extends Очередь implements Очередь, Очередь с очисткой (Просмотреть исходный код)

Трейты

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очередь
protected string	$connectionName	Имя подключения для очереди.	из Очередь
protected bool	$dispatchAfterCommit	Указывает, что задачи должны быть отправлены после подтверждения всех транзакций базы данных.	из Очередь
static protected callable[]	$createPayloadCallbacks	Обратные вызовы для создания полезной нагрузки.	из Очередь
protected Фабрика	$redis	Реализация фабрики Redis.
protected string	$connection	Имя подключения.
protected string	$default	Имя очереди по умолчанию.
protected int\|null	$retryAfter	Время ожидания повторной попытки задачи.
protected int\|null	$blockFor	Максимальное время ожидания задачи в секундах.
protected int	$migrationBatchSize	Размер пакета для миграции отложенных/просроченных задач в основную очередь.

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданного DateTime.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить метку времени Unix для "available at".	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее системное время как метку времени Unix.	из InteractsWithTime
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	из Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в определенную очередь через (n) секунд.	из Queue
void	bulk(array $jobs, mixed $data = '', string\|null $queue = null) Добавить массив задач в очередь.
string	createPayload(Closure\|string\|object $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.	из Queue
array	createPayloadArray(string\|object $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.
array	createObjectPayload(object $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объектов.	из Queue
string	getDisplayName(object $job) Получить имя для отображения для заданной задачи.	из Queue
mixed	getJobTries(mixed $job) Получить максимальное количество попыток для обработчика очереди на основе объектов.	из Queue
mixed	getJobBackoff(mixed $job) Получить отложенное выполнение для обработчика очереди на основе объектов.	из Queue
mixed	getJobExpiration(mixed $job) Получить временную метку истечения срока действия для обработчика очереди на основе объектов.	из Queue
bool	jobShouldBeEncrypted(object $job) Определить, должна ли задача быть зашифрована.	из Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать массив типичной полезной нагрузки очереди на основе строк.	из Queue
static void	createPayloadUsing(callable\|null $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезной нагрузки задачи.	из Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку с использованием зарегистрированных хуков полезной нагрузки.	из Queue
mixed	enqueueUsing(Closure\|string\|object $job, string $payload, string $queue, DateTimeInterface\|DateInterval\|int\|null $delay, callable $callback) Добавить задачу в очередь с использованием заданного обратного вызова.	из Queue
bool	shouldDispatchAfterCommit(Closure\|string\|object $job) Определить, должна ли задача быть запущена после завершения всех транзакций базы данных.	из Queue
void	raiseJobQueueingEvent(Closure\|string\|object $job, string $payload) Сгенерировать событие добавления задачи в очередь.	из Queue
void	raiseJobQueuedEvent(string\|int\|null $jobId, Closure\|string\|object $job, string $payload) Сгенерировать событие добавления задачи в очередь.	из Queue
string	getConnectionName() Получить имя подключения для очереди.	из Queue
$this	setConnectionName(string $name) Установить имя подключения для очереди.	из Queue
Container	getContainer() Получить экземпляр контейнера, используемый подключением.	из Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	из Queue
void	__construct(Factory $redis, string $default = 'default', string\|null $connection = null, int $retryAfter = 60, int\|null $blockFor = null, bool $dispatchAfterCommit = false, int $migrationBatchSize = -1) Создать новый экземпляр очереди Redis.
int	size(string\|null $queue = null) Получить размер очереди.
mixed	push(string\|object $job, mixed $data = '', string\|null $queue = null) Добавить новую задачу в очередь.

mixed	pushRaw(string $payload, string\|null $queue = null, array $options = []) Отправить сырые данные в очередь.
mixed	later(DateTimeInterface\|DateInterval\|int $delay, string\|object $job, mixed $data = '', string\|null $queue = null) Отправить задачу в очередь с задержкой.
mixed	laterRaw(DateTimeInterface\|DateInterval\|int $delay, string $payload, string\|null $queue = null) Отправить сырую задачу в очередь с задержкой (n) секунд.
Job\|null	pop(string\|null $queue = null) Извлечь следующую задачу из очереди.
void	migrate(string $queue) Переместить отложенные или истекшие задачи в основную очередь.
array	migrateExpiredJobs(string $from, string $to) Переместить отложенные задачи, готовые к выполнению, в обычную очередь.
array	retrieveNextJob(string $queue, bool $block = true) Извлечь следующую задачу из очереди.
void	deleteReserved(string $queue, RedisJob $job) Удалить зарезервированную задачу из очереди.
void	deleteAndRelease(string $queue, RedisJob $job, int $delay) Удалить зарезервированную задачу из очереди и освободить ее.
int	clear(string $queue) Удалить все задачи из очереди.
string	getRandomId() Получить случайную строку ID.
string	getQueue(string\|null $queue) Получить очередь или вернуть значение по умолчанию.
Connection	getConnection() Получить соединение для очереди.
Factory	getRedis() Получить базовый экземпляр Redis.

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

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

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

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

array	$jobs
mixed	$data
string\|null	$queue

Return Value

void

protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

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

Parameters

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

Return Value

string

Exceptions

InvalidPayloadException

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

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

Parameters

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

Return Value

array

protected array createObjectPayload(object $job, string $queue)

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

Параметры

объект	$job
строка	$queue

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

массив

protected string getDisplayName(object $job)

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

Параметры

объект

$job

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

строка

mixed getJobTries(mixed $job)

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

Параметры

смешанный

$job

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

смешанный

mixed getJobBackoff(mixed $job)

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

Параметры

смешанный

$job

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

смешанный

mixed getJobExpiration(mixed $job)

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

Параметры

смешанный

$job

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

смешанный

protected bool jobShouldBeEncrypted(object $job)

Определить, следует ли шифровать задание.

Параметры

объект

$job

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

bool

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

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

Параметры

строка	$job
строка	$queue
смешанный	$data

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

массив

static void createPayloadUsing(callable|null $callback)

Зарегистрировать обратный вызов, который будет выполнен при создании загрузки задания.

Параметры

callable|null

$callback

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

void

protected array withCreatePayloadHooks(string $queue, array $payload)

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

Параметры

строка	$queue
массив	$payload

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

массив

protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

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

Параметры

Closure\|string\|object	$job
строка	$payload
строка	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

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

смешанный

protected bool shouldDispatchAfterCommit(Closure|string|object $job)

Определить, следует ли выполнять задание после завершения всех транзакций базы данных.

Параметры

Closure|string|object

$job

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

bool

protected void raiseJobQueueingEvent(Closure|string|object $job, string $payload)

Вызвать событие очереди задания.

Параметры

Closure\|string\|object	$job
строка	$payload

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

void

protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)

Вызвать событие завершенного задания.

Параметры

строка\|int\|null	$jobId
Closure\|string\|object	$job
строка	$payload

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

void

string getConnectionName()

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

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

строка

$this setConnectionName(string $name)

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

Параметры

строка

$name

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

$this

Container getContainer()

Получить экземпляр контейнера, используемый подключением.

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

Container

void setContainer(Container $container)

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

Параметры

Container

$container

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

void

void __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null, bool $dispatchAfterCommit = false, int $migrationBatchSize = -1)

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

Параметры

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

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

void

int size(string|null $queue = null)

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

Параметры

string|null

$queue

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

int

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

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

Параметры

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

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

mixed

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

Добавить сырой payload в очередь.

Параметры

string	$payload
string\|null	$queue
array	$options

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

Job|null pop(string|null $queue = null)

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

Параметры

string|null

$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, bool $block = true)

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

Параметры

string	$queue
bool	$block

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

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

int clear(string $queue)

Удалить все задачи из очереди.

Параметры

string

$queue

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

int

protected string getRandomId()

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

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

string

string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

Connection getConnection()

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

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

Connection

Factory getRedis()

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

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

Factory

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