SyncJob
class SyncJob extends Job implements Job (View source)
Свойства
| InteractsWithTime |
Свойства
| protected mixed | $instance | Экземпляр обработчика задания. | from Job |
| protected Container | $container | Экземпляр контейнера IoC. | from Job |
| protected bool | $deleted | Указывает, было ли задание удалено. | from Job |
| protected bool | $released | Указывает, было ли задание освобождено. | from Job |
| protected bool | $failed | Указывает, потерпел ли провал выполнения задания. | from Job |
| protected string | $connectionName | Имя соединения, к которому относится задание. | from Job |
| protected string | $queue | Имя очереди, к которой относится задание. | from Job |
| protected string | $job | Имя класса задания. | |
| protected string | $payload | Данные сообщения очереди. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени "available at" в формате UNIX timestamp. | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime()
Получить текущее системное время в формате UNIX timestamp. | из InteractsWithTime |
| string | getJobId()
Получить идентификатор задания. | |
| string | getRawBody()
Получить строку с исходным телом задания. | |
| string|null | uuid()
Получить UUID задания. | из Job |
| void | fire()
Запустить задание. | из Job |
| void | delete()
Удалить задание из очереди. | из Job |
| bool | isDeleted()
Определить, было ли задание удалено. | из Job |
| void | release(int $delay = 0)
Вернуть задание обратно в очередь после (n) секунд. | |
| bool | isReleased()
Определить, было ли задание возвращено в очередь. | из Job |
| bool | isDeletedOrReleased()
Определить, было ли задание удалено или возвращено в очередь. | из Job |
| bool | hasFailed()
Определить, было ли задание помечено как ошибочное. | из Job |
| void | markAsFailed()
Пометить задание как "ошибочное". | из Job |
| void | fail(Throwable|null $e = null)
Удалить задание, вызвать метод "failed" и сгенерировать событие о неудачном задании. | из Job |
| void | failed(Throwable|null $e)
Обработать исключение, из-за которого задание завершилось неудачно. | из Job |
| mixed | resolve(string $class)
Разрешить заданный класс. | из Job |
| mixed | getResolvedJob()
Получить экземпляр обработчика задания после разрешения. | из Job |
| array | payload()
Получить декодированное тело задания. | из Job |
| int|null | maxTries()
Получить количество попыток выполнения задания. | из Job |
| int|null | maxExceptions()
Получить количество попыток выполнения задания после исключения. | из Job |
| bool | shouldFailOnTimeout()
Определить, должно ли задание завершиться ошибкой при истечении времени ожидания. | из Job |
| int|int[]|null | backoff()
Количество секунд ожидания перед повторной попыткой выполнения задания, столкнувшегося с необработанным исключением. | из Job |
| int|null | timeout()
Получить количество секунд, в течение которых задание может выполняться. | из Job |
| int|null | retryUntil()
Получить отметку времени, указывающую, когда задание должно истечь. | из Job |
| string | getName()
Получить имя класса задания в очереди. | из Job |
| string | resolveName()
Получить разрешенное имя класса задания в очереди. | из Job |
| string | getConnectionName()
Получить имя подключения, к которому относится задание. | из Job |
| string | getQueue()
Получить имя очереди, к которой относится задание. | |
| Container | getContainer()
Получить экземпляр контейнера сервисов. | из Job |
| void | __construct(Container $container, string $payload, string $connectionName, string $queue)
Создать новый экземпляр задания. | |
| int | attempts()
Получить количество попыток выполнения задания. |
Подробности
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 timestamp.
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, string $payload, string $connectionName, string $queue)
Создать новый экземпляр задачи.
int attempts()
Получить количество попыток выполнения задачи.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/Jobs/SyncJob.html
