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	$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 $delay)

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

from InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

void

fire()

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

from Job

void

delete()

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

bool

isDeleted()

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

from Job

void

release(int $delay)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

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

from Job

void

failed(Exception $e)

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

from Job

mixed

resolve(string $class)

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

timeout()

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

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)

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

string

getRawBody()

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

int

attempts()

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

string

getJobId()

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

Factory

getRedisQueue()

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

string

getReservedJob()

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

Подробности

protected int secondsUntil(DateTimeInterface $delay)

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

Параметры

DateTimeInterface

$delay

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

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int

$delay

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

int

protected int currentTime()

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

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

int

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

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

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

void

void failed(Exception $e)

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

Параметры

Exception

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null timeout()

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

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

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

string getRawBody()

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

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

string

int attempts()

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

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

int

string getJobId()

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

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

string

Factory getRedisQueue()

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

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

Factory

string getReservedJob()

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

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

string

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