Spec-Zone.ru › Laravel 5.4

BeanstalkdJob

class BeanstalkdJob extends Job implements Job (View source)

Свойства

InteractsWithTime

Свойства

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 $connectionName Имя подключения, к которому принадлежит задача. from Job
protected string $queue Имя очереди, к которой принадлежит задача. from Job
protected Pheanstalk $pheanstalk Экземпляр Pheanstalk.
protected Job $job Экземпляр задачи Pheanstalk.

Методы

int secondsUntil(DateTimeInterface $delay)

Количество секунд до указанной даты DateTime.

from InteractsWithTime
int availableAt(DateTimeInterface|int $delay)

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

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
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
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()

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

string getJobId()

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

string getRawBody()

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

Pheanstalk getPheanstalk()

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

Job getPheanstalkJob()

Получить базу данных задачи Pheanstalk.

Подробное описание

protected int secondsUntil(DateTimeInterface $delay)

Количество секунд до указанной даты DateTime.

Parameters

DateTimeInterface $delay

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

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int $delay

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

int

protected int currentTime()

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

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

int

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int $delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

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

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

void

void failed(Exception $e)

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

Параметры

Exception $e

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

void

protected mixed resolve(string $class)

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

Параметры

string $class

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null timeout()

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

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

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

string getJobId()

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

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

string

string getRawBody()

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

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

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API