RedisJob

класс RedisJob расширяет Job и реализует Job (Просмотреть исходный код)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задачи.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, была ли задача удалена.	из Job
protected bool	$released	Указывает, была ли задача выпущена.	из Job
protected bool	$failed	Указывает, произошла ли ошибка в задаче.	из Job
protected string	$connectionName	Имя соединения, к которому принадлежит задача.	из Job
protected string	$queue	Имя очереди, к которой принадлежит задача.	из Job
protected RedisQueue	$redis	Экземпляр очереди Redis.
protected string	$job	Сырые данные задачи Redis.
protected array	$decoded	Декодированная версия JSON "$job".
protected string	$reserved	Данные задачи Redis в резервированной очереди.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

Получить UUID задачи.

from Задача

void

fire()

Запустить задачу.

from Задача

void

delete()

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

bool

isDeleted()

Определить, была ли задача удалена.

from Задача

void

release(int $delay = 0)

Возвратить задачу в очередь.

bool

isReleased()

Определить, была ли задача возвращена в очередь.

from Задача

bool

isDeletedOrReleased()

Определить, была ли задача удалена или возвращена в очередь.

from Задача

bool

hasFailed()

Определить, была ли задача помечена как «ошибка».

from Задача

void

markAsFailed()

Пометить задачу как «ошибка».

from Задача

void

fail(Throwable|null $e = null)

Удалить задачу, вызвать метод «failed» и поднять событие «failed» для задачи.

from Задача

void

failed(Throwable|null $e)

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

from Задача

mixed

resolve(string $class)

Разрешить указанный класс.

from Задача

mixed

getResolvedJob()

Получить экземпляр обработчика задачи после разрешения.

from Задача

array

payload()

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

from Задача

int|null

maxTries()

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

from Задача

int|null

maxExceptions()

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

from Задача

bool

shouldFailOnTimeout()

Определить, должна ли задача завершиться ошибкой по истечении времени выполнения.

from Задача

int|null

backoff()

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

from Задача

int|null

timeout()

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

from Задача

int|null

retryUntil()

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

from Задача

string

getName()

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

from Задача

string

resolveName()

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

from Задача

string

getConnectionName()

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

from Задача

string

getQueue()

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

from Задача

Контейнер

getContainer()

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

from Задача

void

__construct(Контейнер $container, RedisQueue $redis, string $job, string $reserved, string $connectionName, string $queue)

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

int

attempts()

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

RedisQueue

getRedisQueue()

Получить реализацию Redis-фабрики.

string

getReservedJob()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

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

string getJobId()

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

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

string

string getRawBody()

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

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

string

string|null uuid()

Получить UUID задачи.

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

string|null

void fire()

Запустить задачу.

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

void

void delete()

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

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

void

bool isDeleted()

Определить, была ли задача удалена.

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

bool

void release(int $delay = 0)

Вернуть задачу обратно в очередь.

Параметры

int

$delay

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

void

bool isReleased()

Определить, была ли задача возвращена обратно в очередь.

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

bool

bool isDeletedOrReleased()

Определить, была ли задача удалена или возвращена в очередь.

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

bool

bool hasFailed()

Определить, была ли задача помечена как завершённая с ошибкой.

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

bool

void markAsFailed()

Пометить задачу как "ошибка".

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

void

void fail(Throwable|null $e = null)

Удалить задачу, вызвать метод "failed", и вызвать событие завершения задачи с ошибкой.

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

Обработать исключение, приведшее к ошибке выполнения задачи.

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

Разрешить заданный класс.

Параметры

string

$class

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

mixed

mixed getResolvedJob()

Получить разрешённый экземпляр обработчика задач.

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

bool shouldFailOnTimeout()

Определить, должна ли задача завершиться с ошибкой при превышении времени ожидания.

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

bool

int|null backoff()

Количество секунд ожидания перед повторной попыткой выполнения задачи, столкнувшейся с необработанным исключением.

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

int|null

int|null timeout()

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

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

int|null

int|null retryUntil()

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

Значение возврата

int|null

string getName()

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

Значение возврата

string

string resolveName()

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

Разрешает имя «обораченных» задач, таких как обработчики на основе классов.

Значение возврата

string

string getConnectionName()

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

Значение возврата

string

string getQueue()

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

Значение возврата

string

Container getContainer()

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

Значение возврата

Container

void __construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $connectionName, string $queue)

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

Параметры

Container	$container
RedisQueue	$redis
string	$job
string	$reserved
string	$connectionName
string	$queue

Значение возврата

void

int attempts()

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

Значение возврата

int

RedisQueue getRedisQueue()

Получить реализацию базовой фабрики Redis.

Значение возврата

RedisQueue

string getReservedJob()

Получить сохранённую задачу Redis.

Значение возврата

string

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