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