BeanstalkdJob

класс BeanstalkdJob расширяет Job и реализует Job (Просмотреть исходный код)

Трейты

Свойства

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 Pheanstalk	$pheanstalk	Экземпляр Pheanstalk.
protected Job	$job	Экземпляр задачи Pheanstalk.

Методы

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)

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

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, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)

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

void

bury()

Захоронить задание в очереди.

int

attempts()

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

Pheanstalk

getPheanstalk()

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

Job

getPheanstalkJob()

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

Подробности

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 для «доступности».

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.

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, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)

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

Параметры

Container	$container
Pheanstalk	$pheanstalk
Job	$job
string	$connectionName
string	$queue

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

void

void bury()

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

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

void

int attempts()

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

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

int

Pheanstalk getPheanstalk()

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

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

Pheanstalk

Job getPheanstalkJob()

Получить базовый объект задачи Pheanstalk.

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

Job

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