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
protected bool	$released	Указывает, было ли задание возвращено в очередь.	из Job
protected SqsClient	$sqs	Экземпляр клиента Amazon SQS.
protected array	$job	Экземпляр задания Amazon SQS.

Методы

void

fire()

Выполнение задания.

void

delete()

Удаление задания из очереди.

bool

isDeleted()

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

из Job

void

release(int $delay)

Возвращение задания в очередь.

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

int

attempts()

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

string

getRawBody()

Получение исходного тела задания.

void

resolveAndFire(array $payload)

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

из Job

array

parseJob(string $job)

Разбор объявления задания на класс и метод.

из Job

mixed

resolve(string $class)

Обработка указанного обработчика задания.

из Job

mixed

resolveQueueableEntities(mixed $data)

Обработка всех сущностей, подлежащих очереди, в заданном наборе данных.

из Job

QueueableEntity

resolveQueueableEntity(mixed $value)

Обработка одной сущности, подлежащей очереди, из решателя.

из Job

void

failed()

Вызов метода failed у экземпляра задания.

из Job

EntityResolver

getEntityResolver()

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

из Job

int

getSeconds(DateTime|int $delay)

Вычисление количества секунд с заданной задержкой.

из Job

int

getTime()

Получение текущего системного времени.

из Job

string

getName()

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

из Job

string

getQueue()

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

из Job

void

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

Создание нового экземпляра задания.

string

getJobId()

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

Container

getContainer()

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

SqsClient

getSqs()

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

array

getSqsJob()

Получение исходного задания SQS.

Детали

void fire()

Выполнение задания.

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

void

void delete()

Удаление задания из очереди.

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

Возвращение задания в очередь.

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

int attempts()

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

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

int

строка getRawBody()

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

Значение возвращаемого значения

строка

protected void resolveAndFire(array $payload)

Обработать и запустить обработчик задания.

Параметры

массив

$payload

Значение возвращаемого значения

void

protected массив parseJob(string $job)

Разбор объявления задания на класс и метод.

Параметры

строка

$job

Значение возвращаемого значения

массив

protected смешанный тип resolve(string $class)

Обработать заданный обработчик задания.

Параметры

строка

$class

Значение возвращаемого значения

смешанный тип

protected смешанный тип resolveQueueableEntities(mixed $data)

Обработать все элементы задания в заданном наборе данных.

Параметры

смешанный тип

$data

Значение возвращаемого значения

смешанный тип

protected QueueableEntity resolveQueueableEntity(mixed $value)

Обработать отдельный элемент задания из обработчика.

Параметры

смешанный тип

$value

Значение возвращаемого значения

QueueableEntity

void failed()

Вызвать метод failed у экземпляра задания.

Значение возвращаемого значения

void

protected EntityResolver getEntityResolver()

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

Значение возвращаемого значения

EntityResolver

protected целое число getSeconds(DateTime|int $delay)

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

Параметры

DateTime|целое число

$delay

Значение возвращаемого значения

целое число

protected целое число getTime()

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

Значение возвращаемого значения

целое число

строка getName()

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

Значение возвращаемого значения

строка

строка getQueue()

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

Значение возвращаемого значения

строка

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

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

Параметры

Container	$container
SqsClient	$sqs
строка	$queue
массив	$job

Значение возвращаемого значения

void

строка getJobId()

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

Значение возвращаемого значения

строка

Container getContainer()

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

Значение возвращаемого значения

Container

SqsClient getSqs()

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

Значение возвращаемого значения

SqsClient

массив getSqsJob()

Получить базовое сырое задание SQS.

Значение возвращаемого значения

массив

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