Spec-Zone.ru › Laravel 4.2

SqsJob

class SqsJob extends Job (View source)

Свойства

protected mixed $instance Экземпляр обработчика задания. из Job
protected Container $container Экземпляр контейнера IoC. из Job
protected string $queue Имя очереди, к которой принадлежит задание. из Job
protected bool $deleted Указывает, было ли задание удалено. из Job
protected SqsClient $sqs Экземпляр клиента Amazon SQS.
protected array $job Экземпляр задания Amazon SQS.

Методы

void fire()

Запустить задание.

void delete()

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

bool isDeleted()

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

из Job
void release(int $delay)

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

int attempts()

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

string getRawBody()

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

void resolveAndFire(array $payload)

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

из Job
mixed resolve(string $class)

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

из Job
array parseJob(string $job)

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

из Job
bool autoDelete()

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

из 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

int attempts()

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

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

int

string getRawBody()

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

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

string

protected void resolveAndFire(array $payload)

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

Параметры

array $payload

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

void

protected mixed resolve(string $class)

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

Параметры

string $class

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

mixed

protected array parseJob(string $job)

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

Параметры

string $job

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

array

bool autoDelete()

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

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

bool

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int $delay

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

int

protected int getTime()

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

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

int

string getName()

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

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

string

string getQueue()

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

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

string

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

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

Параметры

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

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

void

string getJobId()

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

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

string

Container getContainer()

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

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

Container

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API