CallQueuedListener

class CallQueuedListener implements ShouldQueue (View source)

Трейты

Свойства

Job\|null	$job	Экземпляр базовой очереди задач.	из InteractsWithQueue
string\|null	$connection	Имя подключения, к которому должна быть отправлена задача.	из Queueable
string\|null	$queue	Имя очереди, к которой должна быть отправлена задача.	из Queueable
string\|null	$chainConnection	Имя подключения, к которому должна быть отправлена цепочка задач.	из Queueable
string\|null	$chainQueue	Имя очереди, к которой должна быть отправлена цепочка задач.	из Queueable
array\|null	$chainCatchCallbacks	Обработчики, которые должны выполняться при ошибке в цепочке задач.	из Queueable
DateTimeInterface\|DateInterval\|array\|int\|null	$delay	Количество секунд, которое должно пройти до того, как задача станет доступной.	из Queueable
bool\|null	$afterCommit	Указывает, должна ли задача быть отправлена после завершения всех баз данных.	из Queueable
array	$middleware	Средства, через которые должна быть отправлена задача.	из Queueable
array	$chained	Задачи, которые должны выполняться, если эта задача выполнена успешно.	из Queueable
string	$class	Имя класса прослушивателя.
string	$method	Метод прослушивателя.
array	$data	Данные, которые должны быть переданы прослушивателю.
int	$tries	Количество попыток выполнения задачи.
int	$maxExceptions	Максимальное количество исключений, разрешенных независимо от попыток.
int	$backoff	Количество секунд ожидания перед повторной попыткой выполнения задачи, которая столкнулась с непредвиденным исключением.
int	$retryUntil	Отметка времени, указывающая, когда задача должна истечь.
int	$timeout	Количество секунд, которое задача может работать, прежде чем истечет время ожидания.
bool	$failOnTimeout	Указывает, должна ли задача завершиться неудачей, если время ожидания истекло.
bool	$shouldBeEncrypted	Указывает, должна ли задача быть зашифрована.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

int

attempts()

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

from InteractsWithQueue

void

delete()

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

from InteractsWithQueue

void

fail(Throwable|string|null $exception = null)

Отметить задание как неудачное в очереди.

from InteractsWithQueue

void

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

Вернуть задание в очередь через (n) секунд.

from InteractsWithQueue

$this

setJob(Job $job)

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

from InteractsWithQueue

$this

onConnection(string|null $connection)

Установить желаемое подключение для задания.

from Queueable

$this

onQueue(string|null $queue)

Установить желаемую очередь для задания.

from Queueable

$this

allOnConnection(string|null $connection)

Установить желаемое подключение для цепочки.

from Queueable

$this

allOnQueue(string|null $queue)

Установить желаемую очередь для цепочки.

from Queueable

$this

delay(DateTimeInterface|DateInterval|array|int|null $delay)

Установить желаемую задержку в секундах для задания.

from Queueable

$this

afterCommit()

Указать, что задание должно быть отправлено после фиксации всех транзакций базы данных.

from Queueable

$this

beforeCommit()

Указать, что задание не должно ждать фиксации транзакций базы данных перед отправкой.

from Queueable

$this

through(array|object $middleware)

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

from Queueable

$this

chain(array $chain)

Установить задания, которые должны выполняться, если это задание завершилось успешно.

from Queueable

$this

prependToChain(mixed $job)

Добавить задание в начало текущей цепочки, чтобы оно выполнялось после текущего выполняющегося задания.

from Queueable

$this

appendToChain(mixed $job)

Добавить задание в конец текущей цепочки.

from Queueable

string

serializeJob(mixed $job)

Сериализовать задание для помещения в очередь.

from Queueable

void

dispatchNextJobInChain()

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

from Queueable

void

invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики сбоев заданий цепочки.

from Queueable

void

__construct(string $class, string $method, array $data)

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

void

handle(Container $container)

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

object

setJobInstanceIfNecessary(Job $job, object $instance)

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

void

failed(Throwable $e)

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

void

prepareData()

Рассериализовать данные, если необходимо.

string

displayName()

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

void

__clone()

Подготовить экземпляр для клонирования.

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

Получить метку времени «доступно в» в формате 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 timestamp.

Return Value

int

int attempts()

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

Return Value

int

void delete()

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

Return Value

void

void fail(Throwable|string|null $exception = null)

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

Parameters

Throwable|string|null

$exception

Return Value

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Вернуть задачу в очередь после (n) секунд.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

void

$this setJob(Job $job)

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

Parameters

Job

$job

Return Value

$this

$this onConnection(string|null $connection)

Указать желаемое соединение для задачи.

Parameters

string|null

$connection

Return Value

$this

$this onQueue(string|null $queue)

Указать желаемую очередь для задачи.

Parameters

string|null

$queue

Return Value

$this

$this allOnConnection(string|null $connection)

Указать желаемое соединение для цепочки.

Parameters

string|null

$connection

Return Value

$this

$this allOnQueue(string|null $queue)

Указать желаемую очередь для цепочки.

Parameters

string|null

$queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Установить желаемую задержку в секундах для задачи.

Parameters

DateTimeInterface|DateInterval|array|int|null

$delay

Return Value

$this

$this afterCommit()

Указать, что задача должна быть отправлена после завершения всех транзакций базы данных.

Return Value

$this

$this beforeCommit()

Указать, что задача не должна ожидать завершения транзакций базы данных перед отправкой.

Return Value

$this

$this through(array|object $middleware)

Указать middleware, через который должна быть отправлена задача.

Parameters

array|object

$middleware

Return Value

$this

$this chain(array $chain)

Установить задачи, которые должны выполняться, если эта задача успешно завершится.

Parameters

array

$chain

Return Value

$this

$this prependToChain(mixed $job)

Добавить задачу в начало цепочки, чтобы она выполнялась после текущей задачи.

Parameters

mixed

$job

Return Value

$this

$this appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

Параметры

mixed

$job

Значение возврата

$this

protected string serializeJob(mixed $job)

Сериализовать задачу для очереди.

Параметры

mixed

$job

Значение возврата

string

Исключения

RuntimeException

void dispatchNextJobInChain()

Запустить следующую задачу в цепочке.

Значение возврата

void

void invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики ошибок задач цепочки.

Параметры

Throwable

Значение возврата

void

void __construct(string $class, string $method, array $data)

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

Параметры

string	$class
string	$method
array	$data

Значение возврата

void

void handle(Container $container)

Обработать задачу из очереди.

Параметры

Container

$container

Значение возврата

void

protected object setJobInstanceIfNecessary(Job $job, object $instance)

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

Параметры

Job	$job
object	$instance

Значение возврата

object

void failed(Throwable $e)

Вызвать метод failed у экземпляра задачи.

Будут переданы экземпляр события и исключение.

Параметры

Throwable

Значение возврата

void

protected void prepareData()

Десериализовать данные, если необходимо.

Значение возврата

void

string displayName()

Получить отображаемое имя задачи из очереди.

Значение возврата

string

void __clone()

Подготовить экземпляр для клонирования.

Значение возврата

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Events/CallQueuedListener.html