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 PheanstalkSubscriberInterface | $pheanstalk | Экземпляр Pheanstalk. | |
| protected Job | $job | Экземпляр задачи Pheanstalk. |
Методы
| 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, PheanstalkSubscriberInterface $pheanstalk, JobIdInterface $job, string $connectionName, string $queue)
Создать новый экземпляр задачи. | |
| void | bury()
Поместить задачу в «могилу» очереди. | |
| int | attempts()
Получить количество попыток выполнения задачи. |
| PheanstalkSubscriberInterface | getPheanstalk()
Получить базовый экземпляр Pheanstalk. | |
| JobIdInterface | getPheanstalkJob()
Получить базовый экземпляр задачи Pheanstalk. |
Подробности
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, PheanstalkSubscriberInterface $pheanstalk, JobIdInterface $job, string $connectionName, string $queue)
Создать новый экземпляр задания.
void bury()
Захоронить задание в очереди.
int attempts()
Получить количество попыток выполнения задания.
PheanstalkSubscriberInterface getPheanstalk()
Получить базовый экземпляр Pheanstalk.
JobIdInterface getPheanstalkJob()
Получить базовый Pheanstalk-задание.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/Jobs/BeanstalkdJob.html
