SyncJob

класс SyncJob расширяет Job реализует 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 string	$connectionName	Имя соединения, к которому принадлежит задание.	из Job
protected string	$queue	Имя очереди, к которой принадлежит задание.	из Job
protected string	$job	Имя класса задания.
protected string	$payload	Данные сообщения очереди.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

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

из Job

void

delete()

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

из Job

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

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

Container

getContainer()

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

из Job

void

__construct(Container $container, string $payload, string $connectionName, string $queue)

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

int

attempts()

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

Подробности

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

END_OF_DOCUMENT_MARKER

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 getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

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 delaySeconds()

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

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, string $payload, string $connectionName, string $queue)

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

Параметры

Container	$container
string	$payload
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

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