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