SqsJob
class SqsJob extends Job implements Job (View source)
Свойства
| protected mixed | $instance | Экземпляр обработчика задания. | из Job |
| protected Container | $container | Экземпляр контейнера IoC. | из Job |
| protected string | $queue | Имя очереди, к которой принадлежит задание. | из Job |
| protected bool | $deleted | Указатель, был ли удалён job. | из Job |
| protected bool | $released | Указатель, был ли job высвобожден обратно в очередь. | из Job |
| protected SqsClient | $sqs | Экземпляр клиента Amazon SQS. | |
| protected array | $job | Экземпляр задания Amazon SQS. |
Методы
| int | attempts() Получить количество попыток выполнения задания. | |
| string | getRawBody() Получить строку исходного тела задания. | |
| void | fire() Запустить задание. | из Job |
| mixed | resolve(string $class) Разрешить указанный обработчик задания. | из Job |
| void | delete() Удалить задание из очереди. | |
| bool | isDeleted() Определить, было ли задание удалено. | из Job |
| void | release(int $delay) Вернуть задание обратно в очередь. | |
| bool | isReleased() Определить, было ли задание возвращено обратно в очередь. | из Job |
| bool | isDeletedOrReleased() Определить, было ли задание удалено или возвращено обратно в очередь. | из Job |
| void | failed(Exception $e) Вызвать метод failed для экземпляра задания. | из Job |
| array | parseJob(string $job) Разбор объявления задания на класс и метод. | из Job |
| int | getSeconds(DateTime|int $delay) Рассчитать количество секунд с заданным отсрочкой. | из Job |
| int | getTime() Получить текущее системное время. | из Job |
| string | getName() Получить имя класса задания очереди. | из Job |
| string | resolveName() Получить разрешённое имя класса задания очереди. | из Job |
| array | payload() Получить декодированное тело задания. | из Job |
| string | getQueue() Получить имя очереди, к которой принадлежит задание. | из Job |
| Container | getContainer() Получить экземпляр контейнера сервисов. | из Job |
| void | __construct(Container $container, SqsClient $sqs, string $queue, array $job) Создать новый экземпляр задания. | |
| string | getJobId() Получить идентификатор задания. | |
| SqsClient | getSqs() Получить подлежащий экземпляр клиента SQS. | |
| array | getSqsJob() Получить подлежащий исходный объект задания SQS. |
Детали
int attempts()
Получить количество попыток выполнения задания.
string getRawBody()
Получить строку исходного тела задания.
void fire()
Запустить задание.
protected mixed resolve(string $class)
Разрешить указанный обработчик задания.
void delete()
Удалить задание из очереди.
bool isDeleted()
Определить, было ли задание удалено.
void release(int $delay)
Вернуть задание обратно в очередь.
bool isReleased()
Определить, было ли задание возвращено обратно в очередь.
bool isDeletedOrReleased()
Определить, было ли задание удалено или возвращено обратно в очередь.
void failed(Exception $e)
Вызвать метод failed для экземпляра задания.
protected array parseJob(string $job)
Разбор объявления задания на класс и метод.
protected int getSeconds(DateTime|int $delay)
Вычисление количества секунд с заданной задержкой.
protected int getTime()
Получение текущего системного времени.
string getName()
Получение имени класса очереди задания.
string resolveName()
Получение разрешённого имени класса очереди задания.
array payload()
Получение декодированного тела задания.
string getQueue()
Получение имени очереди, к которой принадлежит задание.
Container getContainer()
Получение экземпляра контейнера сервисов.
void __construct(Container $container, SqsClient $sqs, string $queue, array $job)
Создание нового экземпляра задания.
string getJobId()
Получение идентификатора задания.
SqsClient getSqs()
Получение экземпляра базового клиента SQS.
array getSqsJob()
Получение исходного задания SQS.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Queue/Jobs/SqsJob.html