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.

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

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 timestamp.

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

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

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

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