RedisJob

class RedisJob extends Job implements Job (View source)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задания.	from Job
protected Container	$container	Экземпляр контейнера IoC.	from Job
protected bool	$deleted	Указывает, было ли задание удалено.	from Job
protected bool	$released	Указывает, было ли задание освобождено.	from Job
protected bool	$failed	Указывает, потерпело ли задание неудачу.	from Job
protected string	$connectionName	Имя подключения, к которому относится задание.	from Job
protected string	$queue	Имя очереди, к которой относится задание.	from 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()

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

string|null

uuid()

Получить UUID задания.

from Job

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

maxExceptions()

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

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.

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

string getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

string|null uuid()

Получить UUID задания.

Return Value

string|null

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

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

Parameters

int

$delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

bool

bool hasFailed()

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

Return Value

bool

void markAsFailed()

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

Return Value

void

void fail(Throwable|null $e = null)

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

Parameters

Throwable|null

Return Value

void

protected void failed(Throwable|null $e)

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

Parameters

Throwable|null

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

mixed getResolvedJob()

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

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null maxExceptions()

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

Return Value

int|null

int|null delaySeconds()

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null timeoutAt()

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

Return Value

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

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/7.x/Illuminate/Queue/Jobs/RedisJob.html