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)

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

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

Выполнить задание.

из Job

void

delete()

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

bool

isDeleted()

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

из Job

void

release(int $delay = 0)

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

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

Пометить задание как "неудачное".

из Job

void

fail(Throwable|null $e = null)

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

из Job

void

failed(Throwable|null $e)

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

из Job

mixed

resolve(string $class)

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

из Job

mixed

getResolvedJob()

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

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

delaySeconds()

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

из Job

int|null

timeout()

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

из Job

int|null

timeoutAt()

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

из Job

string

getName()

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

из Job

string

resolveName()

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

из Job

string

getConnectionName()

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

из Job

string

getQueue()

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

из Job

Container

getContainer()

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

из 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)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

string getJobId()

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

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

string

string getRawBody()

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

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

string

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задание как «неисправное».

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

void

void fail(Throwable|null $e = null)

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

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

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

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

mixed getResolvedJob()

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

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null delaySeconds()

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

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

END_OF_DOCUMENT_MARKER

Контейнер getContainer()

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

Значение возвращаемого значения

Контейнер

void __construct(Контейнер $container, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)

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

Параметры

Контейнер	$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/6.x/Illuminate/Queue/Jobs/BeanstalkdJob.html