Spec-Zone.ru › Laravel 5.3

RedisJob

class RedisJob 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 RedisQueue $redis Экземпляр очереди Redis.
protected string $job Необработанная нагрузка задачи Redis.
protected array $decoded Декодированная версия JSON "$job".
protected string $reserved Нагрузка задачи Redis в резервной очереди.

Методы

int attempts()

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

string getRawBody()

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

void fire()

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

из Job
mixed resolve(string $class)

Разрешить заданный обработчик задач.

из Job
void delete()

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

bool isDeleted()

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

из Job
void release(int $delay)

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

bool isReleased()

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

из Job
bool isDeletedOrReleased()

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

из Job
void failed(Exception $e)

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

из Job
array parseJob(string $job)

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

из Job
int getSeconds(DateTime|int $delay)

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

из Job
int getTime()

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

из Job
string getName()

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

из Job
string resolveName()

Получение разрешённого имени класса задачи в очереди.

из Job
array payload()

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

из Job
string getQueue()

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

из Job
Container getContainer()

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

из Job
__construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $queue)

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

string getJobId()

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

Database getRedisQueue()

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

string getReservedJob()

Получить подлежащую задачу Redis из резервной очереди.

Подробности

int attempts()

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

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

int

string getRawBody()

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

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

string

void fire()

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

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

void

protected mixed resolve(string $class)

Разрешить заданный обработчик задач.

Параметры

string $class

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

mixed

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int $delay

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

void

bool isReleased()

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

Результат

bool

bool isDeletedOrReleased()

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

Результат

bool

void failed(Exception $e)

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

Параметры

Exception $e

Результат

void

protected array parseJob(string $job)

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

Параметры

string $job

Результат

array

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int $delay

Результат

int

protected int getTime()

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

Результат

int

string getName()

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

Результат

string

string resolveName()

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

Результат

string

array payload()

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

Результат

array

string getQueue()

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

Результат

string

Container getContainer()

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

Результат

Container

__construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $queue)

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

Параметры

Container $container
RedisQueue $redis
string $job
string $reserved
string $queue

string getJobId()

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

Результат

string

Database getRedisQueue()

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

Результат

Database

string getReservedJob()

Получение базовой сохранённой задачи Redis.

Результат

string

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

Spec-Zone.ru

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