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.

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

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

from Job

void

delete()

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

bool

isDeleted()

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

from Job

void

release(int $delay = 0)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

Пометить задание как "с ошибкой".

from Job

void

fail(Throwable|null $e = null)

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

from Job

void

failed(Throwable|null $e)

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

from Job

mixed

resolve(string $class)

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

from Job

mixed

getResolvedJob()

Получить экземпляр обработчика задания, разрешенного.

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

delaySeconds()

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

from Job

int|null

timeout()

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

from Job

int|null

timeoutAt()

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

from Job

string

getName()

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

from Job

string

resolveName()

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

from Job

string

getConnectionName()

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

from Job

string

getQueue()

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

from Job

Container

getContainer()

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

from Job

void

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

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

int

attempts()

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

RedisQueue

getRedisQueue()

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

string

getReservedJob()

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

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

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)

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

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

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

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

mixed getResolvedJob()

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

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

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

Контейнер getContainer()

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

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

Контейнер

void __construct(Контейнер $container, RedisQueue $redis, string $job, string $reserved, string $connectionName, string $queue)

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

Параметры

Контейнер	$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/6.x/Illuminate/Queue/Jobs/RedisJob.html