RedisJob
класс RedisJob расширяет Job и реализует Job (Просмотреть исходный код)
Трейты
| InteractsWithTime |
Свойства
| 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. | from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение представляет интервал, преобразовать его в экземпляр DateTime. | from InteractsWithTime |
| int | currentTime()
Получить текущее системное время в формате UNIX timestamp. | from InteractsWithTime |
| string | runTimeForHumans(float $startTime, float $endTime = null)
Учитывая начальное время, отформатировать общее время выполнения для удобного восприятия человеком. | from InteractsWithTime |
| string | getJobId()
Получить идентификатор задачи. | |
| string | getRawBody()
Получить строку с исходным телом задачи. | |
| string|null | uuid()
Получить UUID задачи. | from Job |
| void | fire()
Запустить задачу. | from Job |
| void | delete()
Удалить задачу из очереди. | |
| bool | isDeleted()
Определить, была ли задача удалена. | from Job |
| void | release(int $delay = 0)
Возвратить задачу в очередь после (n) секунд. | |
| bool | isReleased()
Определить, была ли задача возвращена в очередь. | from Job |
| bool | isDeletedOrReleased()
Определить, была ли задача удалена или возвращена в очередь. | from Job |
| bool | hasFailed()
Определить, была ли задача помечена как завершившаяся с ошибкой. | from Job |
| void | markAsFailed()
Пометить задачу как завершившуюся с ошибкой. | from Job |
| void | fail(Throwable|null $e = null)
Удалить задачу, вызвать метод «failed» и поднять событие о завершении задачи с ошибкой. | from Job |
| void | failed(Throwable|null $e)
Обработать исключение, приведшее к завершению задачи с ошибкой. | from Job |
| mixed | resolve(string $class)
Разрешить указанный класс. | from Job |
| mixed | getResolvedJob()
Получить экземпляр обработчика задачи, полученного после разрешения. | from Job |
| array | payload()
Получить декодированное тело задачи. | from Job |
| int|null | maxTries()
Получить количество попыток выполнения задачи. | from Job |
| int|null | maxExceptions()
Получить количество попыток выполнения задачи после исключения. | from Job |
| bool | shouldFailOnTimeout()
Определить, должна ли задача завершиться с ошибкой при истечении времени. | from Job |
| int|int[]|null | backoff()
Количество секунд ожидания перед повторной попыткой выполнения задачи, которая столкнулась с необработанным исключением. | from Job |
| int|null | timeout()
Получить количество секунд, в течение которых задача может выполняться. | from Job |
| int|null | retryUntil()
Получить метку времени, указывающую, когда задача должна завершиться с ошибкой из-за истечения времени. | from Job |
| string | getName()
Получить имя класса задачи в очереди. | from Job |
| string | resolveName()
Получить разрешенное имя класса задачи в очереди. | from Job |
| string | getConnectionName()
Получить имя подключения, к которому относится задача. | from Job |
| string | getQueue()
Получить имя очереди, к которой относится задача. | from Job |
| Container | getContainer()
Получить экземпляр контейнера сервисов. | from Job |
| void | __construct(Container $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)
Получить количество секунд до указанной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени «доступно в» в формате Unix.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение — интервал, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате метки времени Unix.
protected string runTimeForHumans(float $startTime, float $endTime = null)
Вывести общее время выполнения в формате, понятном человеку.
string getJobId()
Получить идентификатор задачи.
string getRawBody()
Получить исходный строковый текст тела задачи.
string|null uuid()
Получить UUID задачи.
void fire()
Запустить задачу.
void delete()
Удалить задачу из очереди.
bool isDeleted()
Определить, была ли задача удалена.
void release(int $delay = 0)
Вернуть задачу в очередь после (n) секунд.
bool isReleased()
Определить, была ли задача возвращена в очередь.
bool isDeletedOrReleased()
Определить, была ли задача удалена или возвращена в очередь.
bool hasFailed()
Определить, была ли задача помечена как неудачная.
void markAsFailed()
Пометить задачу как «неудачную».
void fail(Throwable|null $e = null)
Удалить задачу, вызвать метод «failed» и сгенерировать событие неудачной задачи.
protected void failed(Throwable|null $e)
Обработать исключение, вызвавшее сбой задачи.
protected mixed resolve(string $class)
Разрешить заданный класс.
mixed getResolvedJob()
Получить экземпляр обработчика решенной задачи.
array payload()
Получить декодированное тело задачи.
int|null maxTries()
Получить количество попыток выполнения задачи.
int|null maxExceptions()
Получить количество попыток выполнения задачи после исключения.
bool shouldFailOnTimeout()
Определить, должно ли задание завершиться с ошибкой при истечении времени ожидания.
int|int[]|null backoff()
Количество секунд ожидания перед повторной попыткой выполнения задания, столкнувшегося с непредвиденной ошибкой.
int|null timeout()
Получить количество секунд, в течение которых задание может выполняться.
int|null retryUntil()
Получить отметку времени, указывающую, когда задание должно истечь.
string getName()
Получить имя класса очереди задания.
string resolveName()
Получить разрешённое имя класса очереди задания.
Разрешает имя «упакованных» заданий, таких как обработчики на основе классов.
string getConnectionName()
Получить имя подключения, к которому относится задание.
string getQueue()
Получить имя очереди, к которой относится задание.
Container getContainer()
Получить экземпляр контейнера сервисов.
void __construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $connectionName, string $queue)
Создать новый экземпляр задания.
int attempts()
Получить количество попыток выполнения задания.
RedisQueue getRedisQueue()
Получить реализацию базового объекта Redis.
string getReservedJob()
Получить сохранённое Redis-задание.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/Jobs/RedisJob.html
