BeanstalkdJob

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

void

bury()

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

int

attempts()

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

int

getJobId()

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

Pheanstalk

getPheanstalk()

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

Job

getPheanstalkJob()

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

Details

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

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

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.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

string getRawBody()

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

Return Value

string

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay)

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

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 failed(Exception $e)

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

Parameters

Exception

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null timeoutAt()

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

Return Value

int|null

string getName()

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

Return Value

string

string resolveName()

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

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

Return Value

string

string getConnectionName()

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

Return Value

string

string getQueue()

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

Return Value

string

Container getContainer()

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

Return Value

Container

void __construct(Container $container, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)

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

Parameters

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

Return Value

void

void bury()

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

Return Value

void

int attempts()

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

Return Value

int

int getJobId()

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

Return Value

int

Pheanstalk getPheanstalk()

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

Return Value

Pheanstalk

Задание getPheanstalkJob()

Получить базовую работу Pheanstalk.

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

Задание

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