BeanstalkdJob

class BeanstalkdJob 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 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)

Удалить задание, вызвать метод "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

bool

shouldFailOnTimeout()

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

from Job

int|null

backoff()

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

from Job

int|null

timeout()

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

from Job

int|null

retryUntil()

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

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 "доступно в" (available at).

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

bool shouldFailOnTimeout()

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

Return Value

bool

int|null backoff()

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null retryUntil()

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

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

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