SqsJob

класс SqsJob расширяет Job и реализует Job (View source)

Свойства

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	$connectionName	Имя подключения, к которому относится задача.	from Job
protected string	$queue	Имя очереди, к которой относится задача.	from Job
protected SqsClient	$sqs	Экземпляр клиента Amazon SQS.
protected array	$job	Экземпляр задачи Amazon SQS.

Методы

int

secondsUntil(DateTimeInterface $delay)

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

from InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

void

fire()

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

from Job

void

delete()

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

bool

isDeleted()

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

from Job

void

release(int $delay)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

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

from Job

void

failed(Exception $e)

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

from Job

mixed

resolve(string $class)

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

timeout()

Количество секунд, в течение которых может выполняться задача.

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, 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)

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

Parameters

DateTimeInterface

$delay

Return Value

int

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.5/Illuminate/Queue/Jobs/SqsJob.html