BeanstalkdJob
class BeanstalkdJob 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 Pheanstalk | $pheanstalk | Экземпляр Pheanstalk. | |
| protected Job | $job | Экземпляр задания Pheanstalk. |
Методы
| 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 |
| string | getJobId() Получить идентификатор задания. | |
| string | getRawBody() Получить строку исходного тела задания. | |
| string|null | uuid() Получить UUID задания. | из Job |
| void | fire() Запустить задание. | из Job |
| void | delete() Удалить задание из очереди. | |
| 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() Получить имя очереди, к которой принадлежит задание. | из Job |
| Container | getContainer() Получить экземпляр контейнера сервисов. | из Job |
| void | __construct(Container $container, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue) Создать новый экземпляр задания. | |
| void | bury() Поместить задание в очередь "захоронения". | |
| int | attempts() Получить количество попыток выполнения задания. | |
| Pheanstalk | getPheanstalk() Получить базовый экземпляр Pheanstalk. | |
| Job | getPheanstalkJob() Получить базовый экземпляр задания Pheanstalk. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени "доступно в" в формате Unix timestamp.
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, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)
Создать новый экземпляр задачи.
void bury()
Поместить задачу в очередь на хранение.
int attempts()
Получить количество попыток выполнения задачи.
Pheanstalk getPheanstalk()
Получить базовый экземпляр Pheanstalk.
Job getPheanstalkJob()
Получить базовый экземпляр задачи Pheanstalk.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/Jobs/BeanstalkdJob.html
