RedisJob
class RedisJob extends Job implements Job (View source)
Трейты
| InteractsWithTime |
Свойства
| protected mixed | $instance | Экземпляр обработчика задачи. | из Job |
| protected Container | $container | Экземпляр контейнера IoC. | из Job |
| protected bool | $deleted | Указывает, была ли задача удалена. | из Job |
| protected bool | $released | Указывает, была ли задача освобождена. | из Job |
| protected bool | $failed | Указывает, произошла ли ошибка в задаче. | из Job |
| protected | $connectionName | Имя соединения, к которому относится задача. | из Job |
| protected string | $queue | Имя очереди, к которой относится задача. | из Job |
| protected RedisQueue | $redis | Экземпляр очереди Redis. | |
| protected string | $job | Сырые данные задачи Redis. | |
| protected array | $decoded | Декодированная версия "$job" в формате JSON. | |
| protected string | $reserved | Данные задачи Redis в резервированной очереди. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до указанной даты и времени. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить UNIX-метку времени «доступно в». | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение является интервалом, преобразовать его в объект DateTime. | из InteractsWithTime |
| int | currentTime() Получить текущее системное время в виде UNIX-метки времени. | из InteractsWithTime |
| string | getJobId() Получить идентификатор задания. | |
| string | getRawBody() Получить строку исходного тела задания. | |
| void | fire() Запустить задание. | из Job |
| void | delete() Удалить задание из очереди. | |
| bool | isDeleted() Определить, было ли задание удалено. | из Job |
| void | release(int $delay = 0) Вернуть задание обратно в очередь. | |
| bool | isReleased() Определить, было ли задание возвращено обратно в очередь. | из Job |
| bool | isDeletedOrReleased() Определить, было ли задание удалено или возвращено обратно в очередь. | из Job |
| bool | hasFailed() Определить, было ли задание помечено как завершенное с ошибкой. | из Job |
| void | markAsFailed() Пометить задание как завершенное с ошибкой. | из Job |
| void | failed(Exception $e) Обработать исключение, вызвавшее ошибку задания. | из Job |
| mixed | resolve(string $class) Разрешить указанный класс. | из Job |
| array | payload() Получить декодированное тело задания. | из Job |
| int|null | maxTries() Получить количество попыток выполнения задания. | из Job |
| int|null | timeout() Получить количество секунд, которое задание может работать. | из Job |
| int|null | timeoutAt() Получить отметку времени, указывающую, когда задание должно истечь. | из Job |
| string | getName() Получить имя класса задания в очереди. | из Job |
| string | resolveName() Получить разрешенное имя класса задания в очереди. | из Job |
| string | getConnectionName() Получить имя подключения, к которому относится задание. | из Job |
| string | getQueue() Получить имя очереди, к которой относится задание. | из Job |
| Container | getContainer() Получить экземпляр контейнера сервисов. | из Job |
| void | __construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $connectionName, string $queue) Создать новый экземпляр задания. | |
| int | attempts() Получить количество попыток выполнения задания. | |
| Factory | 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.
string getJobId()
Получить идентификатор задачи.
string getRawBody()
Получить строку исходного тела для задачи.
void fire()
Запустить задачу.
void delete()
Удалить задачу из очереди.
bool isDeleted()
Определить, была ли задача удалена.
void release(int $delay = 0)
Вернуть задачу обратно в очередь.
bool isReleased()
Определить, была ли задача возвращена обратно в очередь.
bool isDeletedOrReleased()
Определить, была ли задача удалена или возвращена в очередь.
bool hasFailed()
Определить, была ли задача помечена как неисправная.
void markAsFailed()
Пометить задачу как "неудачная".
void failed(Exception $e)
Обработать исключение, которое привело к ошибке задачи.
protected mixed resolve(string $class)
Разрешить заданный класс.
array payload()
Получить декодированное тело задачи.
int|null maxTries()
Получить количество попыток выполнения задачи.
int|null timeout()
Получить количество секунд, в течение которых задача может выполняться.
int|null timeoutAt()
Получить метку времени, указывающую, когда задача должна истечь.
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()
Получить количество попыток выполнения задачи.
Factory getRedisQueue()
Получить реализацию базового фабрики Redis.
string getReservedJob()
Получить базовую зарезервированную задачу Redis.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Queue/Jobs/RedisJob.html
