RedisJob

class RedisJob extends Job implements Job (View source)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задания.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, было ли задание удалено.	из Job
protected bool	$released	Указывает, было ли задание выпущено.	из Job
protected bool	$failed	Указывает, потерпел ли провал.	из Job
protected string	$connectionName	Имя соединения, к которому относится задание.	из Job
protected string	$queue	Имя очереди, к которой относится задание.	из Job
protected RedisQueue	$redis	Экземпляр очереди Redis.
protected string	$job	Необработанная нагрузка задания Redis.
protected array	$decoded	Декодированная версия JSON "$job".
protected string	$reserved	Нагрузка задания Redis в резервированной очереди.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

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

из Job

void

delete()

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

bool

isDeleted()

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

из Job

void

release(int $delay = 0)

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

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

Пометить задачу как «не выполненную».

из Job

void

fail(Throwable|null $e = null)

Удалить задачу, вызвать метод «failed», и поднять событие о невыполнении задачи.

из Job

void

failed(Throwable|null $e)

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

из Job

mixed

resolve(string $class)

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

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

delaySeconds()

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

из Job

int|null

timeout()

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

из Job

int|null

timeoutAt()

Получить отметку времени, указывающую, когда задача должна истечь.

из Job

string

getName()

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

из Job

string

resolveName()

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

из Job

string

getConnectionName()

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

из Job

string

getQueue()

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

из Job

Container

getContainer()

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

из Job

void

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

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

int

attempts()

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

RedisQueue

getRedisQueue()

Получить реализацию базовой фабрики Redis.

string

getReservedJob()

Получить сохранённую задачу Redis.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить временную метку UNIX «доступно в».

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

string getJobId()

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

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

string

string getRawBody()

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

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

string

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задачу как «ошибочная».

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

void

void fail(Throwable|null $e = null)

Удалить задачу, вызвать метод «ошибка» и сгенерировать событие о завершении задачи с ошибкой.

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

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

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null delaySeconds()

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

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

Получить временную метку, указывающую, когда задача должна истечь.

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

int|null

string getName()

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

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

string

string resolveName()

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

Разрешает имя «упакованных» задач, таких как обработчики на основе классов.

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

void

int attempts()

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

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

int

RedisQueue getRedisQueue()

Получить реализацию базового Redis-фреймворка.

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

RedisQueue

string getReservedJob()

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

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

string

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