SqsJob

class SqsJob extends Job implements Job (View source)

Свойства

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 SqsClient	$sqs	Экземпляр клиента Amazon SQS.
protected array	$job	Экземпляр задачи Amazon SQS.

Методы

int

secondsUntil(DateTimeInterface $delay)

Получить количество секунд до указанной даты и времени.

из InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

Получить отметку времени «доступно в» (UNIX timestamp).

из InteractsWithTime

int

currentTime()

Получить текущее системное время в формате UNIX timestamp.

из InteractsWithTime

void

fire()

Выполнить задачу.

из Job

void

delete()

Удалить задачу из очереди.

bool

isDeleted()

Определить, была ли задача удалена.

из Job

void

release(int $delay)

Освободить задачу обратно в очередь.

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

string

getName()

Получить имя класса задачи, помещённой в очередь.

из Job

string

resolveName()

Получить разрешённое имя класса задачи, помещённой в очередь.

из Job

string

getConnectionName()

Получить имя подключения, к которому относится задача.

из Job

string

getQueue()

Получить имя очереди, к которой относится задача.

из Job

Container

getContainer()

Получить экземпляр контейнера сервисов.

из Job

void

__construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

int

attempts()

Получить количество попыток выполнения задачи.

string

getJobId()

Получить идентификатор задачи.

string

getRawBody()

Получить исходное тело задачи в виде строки.

SqsClient

getSqs()

Получить экземпляр базового клиента SQS.

array

getSqsJob()

Получить базовую задачу SQS.

Подробное описание

protected int secondsUntil(DateTimeInterface $delay)

Получить количество секунд до указанной даты и времени.

Параметры

DateTimeInterface

$delay

Возвращаемое значение

int

END_OF_DOCUMENT_MARKER

protected int availableAt(DateTimeInterface|int $delay)

Получить отметку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|int

$delay

Значение возврата

int

protected int currentTime()

Получить текущее системное время в формате UNIX.

Значение возврата

int

void fire()

Запустить задачу.

Значение возврата

void

void delete()

Удалить задачу из очереди.

Значение возврата

void

bool isDeleted()

Определить, была ли задача удалена.

Значение возврата

bool

void release(int $delay)

Вернуть задачу обратно в очередь.

Параметры

int

$delay

Значение возврата

void

bool isReleased()

Определить, была ли задача возвращена в очередь.

Значение возврата

bool

bool isDeletedOrReleased()

Определить, была ли задача удалена или возвращена в очередь.

Значение возврата

bool

bool hasFailed()

Определить, была ли задача помечена как завершенная с ошибкой.

Значение возврата

bool

void markAsFailed()

Пометить задачу как завершенную с ошибкой.

Значение возврата

void

void failed(Exception $e)

Обработать исключение, приведшее к завершению задачи с ошибкой.

Параметры

Exception

Значение возврата

void

protected mixed resolve(string $class)

Разрешить указанный класс.

Параметры

string

$class

Значение возврата

mixed

array payload()

Получить декодированное тело задачи.

Значение возврата

array

int|null maxTries()

Количество попыток выполнения задачи.

Значение возврата

int|null

int|null timeout()

Количество секунд для выполнения задачи.

Значение возврата

int|null

string getName()

Получить имя класса очереди задач.

Значение возврата

string

string resolveName()

Получить разрешённое имя класса очереди задач.

Разрешает имя «обораченных» задач, таких как обработчики на основе класса.

Значение возврата

string

string getConnectionName()

Получить имя подключения, к которому принадлежит задача.

Значение возврата

string

string getQueue()

Получить имя очереди, к которой принадлежит задача.

Значение возврата

string

Container getContainer()

Получить экземпляр контейнера сервисов.

Значение возврата

Container

void __construct(Container $container, SqsClient $sqs, array $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

Параметры

Container	$container
SqsClient	$sqs
array	$job
string	$connectionName
string	$queue

Значение возврата

void

int attempts()

Получить количество попыток выполнения задачи.

Значение возврата

int

string getJobId()

Получить идентификатор задачи.

Значение возврата

string

string getRawBody()

Получить исходное тело задачи в виде строки.

Значение возврата

string

SqsClient getSqs()

Получить базовый экземпляр клиента SQS.

Значение возврата

SqsClient

array getSqsJob()

Получить базовый исходный объект задачи SQS.

Значение возврата

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Queue/Jobs/SqsJob.html