RedisQueue

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

Трейты

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очередь
protected string	$connectionName	Имя соединения для очереди.	из Очередь
protected	$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.	from InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить отметку времени "доступно в" в формате UNIX timestamp.	from InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	from InteractsWithTime
int	currentTime() Получить текущее системное время в формате UNIX timestamp.	from InteractsWithTime
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	from Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в определённую очередь после (n) секунд.	from Queue
void	bulk(array $jobs, mixed $data = '', string\|null $queue = null) Добавить массив задач в очередь.
string	createPayload(Closure\|string\|object $job, string $queue, mixed $data = '') Создать строковое представление payload из заданной задачи и данных.	from Queue
array	createPayloadArray(string\|object $job, string $queue, mixed $data = '') Создать массив payload из заданной задачи и данных.
array	createObjectPayload(object $job, string $queue) Создать payload для обработчика очереди на основе объектов.	from Queue
string	getDisplayName(object $job) Получить отображаемое имя для заданной задачи.	from Queue
mixed	getJobBackoff(mixed $job) Получить задержку для обработчика очереди на основе объектов.	from Queue
mixed	getJobExpiration(mixed $job) Получить отметку времени истечения срока действия для обработчика очереди на основе объектов.	from Queue
bool	jobShouldBeEncrypted(object $job) Определить, должна ли задача быть зашифрована.	from Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать массив обычного payload для очереди на основе строк.	from Queue
static void	createPayloadUsing(callable\|null $callback) Зарегистрировать обработчик, который будет выполнен при создании payload задачи.	from Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданный payload, используя любые зарегистрированные обработчики payload.	from Queue
mixed	enqueueUsing(Closure\|string\|object $job, string $payload, string $queue, DateTimeInterface\|DateInterval\|int\|null $delay, callable $callback) Добавить задачу в очередь, используя указанный обработчик.	from Queue
bool	shouldDispatchAfterCommit(Closure\|string\|object $job) Определить, должна ли задача быть запущена после завершения всех баз данных.	from Queue
void	raiseJobQueuedEvent(string\|int\|null $jobId, Closure\|string\|object $job) Сгенерировать событие о добавлении задачи в очередь.	from Queue
string	getConnectionName() Получить имя соединения для очереди.	from Queue
$this	setConnectionName(string $name) Установить имя соединения для очереди.	from Queue
Container	getContainer() Получить экземпляр контейнера, используемый соединением.	from Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	from 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 = []) Добавить raw payload в очередь.
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)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить временную метку "доступно в" в формате 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.

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

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 = '')

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

Параметры

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

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

mixed

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

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

Параметры

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

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

void

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

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

Параметры

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

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

string

Исключения

InvalidPayloadException

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

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

Параметры

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

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

array

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

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

Параметры

object	$job
string	$queue

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

array

protected string getDisplayName(object $job)

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

Параметры

object

$job

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

string

mixed getJobBackoff(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobExpiration(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

protected bool jobShouldBeEncrypted(object $job)

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

Parameters

object

$job

Return Value

bool

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

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

Parameters

string	$job
string	$queue
mixed	$data

Return Value

array

static void createPayloadUsing(callable|null $callback)

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

Parameters

callable|null

$callback

Return Value

void

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

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

Parameters

string	$queue
array	$payload

Return Value

array

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

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

Parameters

Closure\|string\|object	$job
string	$payload
string	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

Return Value

mixed

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

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

Parameters

Closure|string|object

$job

Return Value

bool

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

Сгенерировать событие о вставленном задании.

Parameters

string\|int\|null	$jobId
Closure\|string\|object	$job

Return Value

void

string getConnectionName()

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

Return Value

string

$this setConnectionName(string $name)

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

Parameters

string

$name

Return Value

$this

Container getContainer()

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

Return Value

Container

void setContainer(Container $container)

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

Parameters

Container

$container

Return Value

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.

Parameters

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

Return Value

void

int size(string|null $queue = null)

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

Parameters

string|null

$queue

Return Value

int

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

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()

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

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

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/9.x/Illuminate/Queue/RedisQueue.html