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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

getRawBody()

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

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

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()

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

string

getJobId()

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

Factory

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)

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

string getRawBody()

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

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

string

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

int|null timeoutAt()

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

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

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

string getJobId()

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

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

string

Factory getRedisQueue()

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

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

Factory

END_OF_DOCUMENT_MARKER

string getReservedJob()

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

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

string

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