RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Особенности

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected string	$connectionName	Имя соединения для очереди.	из Queue
static protected callable\|null	$createPayloadCallback	Обратный вызов создания полезной нагрузки.	из 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.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить UNIX-временную метку "доступно в".	из 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 = '') Добавить новую задачу в очередь после задержки.	из Queue
mixed	bulk(array $jobs, mixed $data = '', string $queue = null) Добавить массив задач в очередь.	из Queue
string	createPayload(string $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.	из Queue
array	createPayloadArray(mixed $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.
array	createObjectPayload(mixed $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объектов.	из Queue
string	getDisplayName(mixed $job) Получить отображаемое имя для заданной задачи.	из Queue
mixed	getJobExpiration(mixed $job) Получить временную метку истечения срока действия задачи для обработчика очереди на основе объектов.	из Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать массив типичной полезной нагрузки очереди на основе строк.	из Queue
static void	createPayloadUsing(callable $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезной нагрузки задач.	из Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку с использованием зарегистрированных хуков полезной нагрузки.	из 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, 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)

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

Параметры

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

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

Параметры

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, string $queue, mixed $data = '')

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

Параметры

string	$job
string	$queue
mixed	$data

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

string

Исключения

InvalidPayloadException

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

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

Параметры

mixed	$job
string	$queue
mixed	$data

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

array

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

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

Параметры

mixed	$job
string	$queue

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

array

protected string getDisplayName(mixed $job)

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

Параметры

mixed

$job

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

string

mixed getJobExpiration(mixed $job)

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

Параметры

mixed

$job

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

mixed

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

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

Параметры

string	$job
string	$queue
mixed	$data

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

array

static void createPayloadUsing(callable $callback)

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

Параметры

callable

$callback

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

void

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

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

Параметры

string	$queue
array	$payload

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

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

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

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

Параметры

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

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

mixed

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

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

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

DateTimeInterface\|DateInterval\|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

protected array blockingPop(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

string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

protected 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/5.7/Illuminate/Queue/RedisQueue.html