Spec-Zone.ru › Laravel 11

CallQueuedListener

класс CallQueuedListener реализует ShouldQueue (View source)

Трейты

InteractsWithQueue
Queueable
InteractsWithTime

Свойства

Job|null $job

Экземпляр задачи очереди.

из InteractsWithQueue
string|null $connection

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

из Queueable
string|null $queue

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

из Queueable
DateTimeInterface|DateInterval|array|int|null $delay

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

из Queueable
bool|null $afterCommit

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

из Queueable
array $middleware

Средства, через которые должна быть отправлена задача.

из Queueable
array $chained

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

из Queueable
string|null $chainConnection

Имя подключения, к которому должна быть отправлена цепочка.

из Queueable
string|null $chainQueue

Имя очереди, к которому должна быть отправлена цепочка.

из Queueable
array|null $chainCatchCallbacks

Обработчики, которые должны быть выполнены при сбое цепочки.

из 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
string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатируйте общее время выполнения для удобочитаемости человеком.

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

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

from InteractsWithQueue
$this assertDeleted()

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

from InteractsWithQueue
$this assertFailed()

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

from InteractsWithQueue
$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

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

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

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

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)

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

из Queueable
void assertHasChain(array $expectedChain)

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

из Queueable
void assertDoesntHaveChain()

Проверить, что задаче больше нет задач в цепочке.

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

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

protected string runTimeForHumans(float $startTime, float $endTime = null)

При заданном начальном времени, отформатировать общее время выполнения для удобного чтения человеком.

Parameters

float $startTime
float $endTime

Return Value

string

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

Указать, что взаимодействия с очередью (например, fail, delete, release) должны быть смоделированы.

Return Value

$this

$this assertDeleted()

Утверждение, что задача была удалена из очереди.

Return Value

$this

$this assertFailed()

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

Return Value

$this

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

$this

$this setJob(Job $job)

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

Parameters

Job $job

Return Value

$this

$this onConnection(string|null $connection)

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

Параметры

string|null $connection

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

$this

$this onQueue(string|null $queue)

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

Параметры

string|null $queue

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

$this

$this allOnConnection(string|null $connection)

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

Параметры

string|null $connection

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

$this

$this allOnQueue(string|null $queue)

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

Параметры

string|null $queue

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

$this

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

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

Параметры

DateTimeInterface|DateInterval|array|int|null $delay

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

$this

$this withoutDelay()

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

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

$this

$this afterCommit()

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

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

$this

$this beforeCommit()

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

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

$this

$this through(array|object $middleware)

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

Параметры

array|object $middleware

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

$this

$this chain(array $chain)

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

Параметры

array $chain

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

$this

$this prependToChain(mixed $job)

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

Параметры

mixed $job

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

$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 $e

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

void

void assertHasChain(array $expectedChain)

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

Параметры

array $expectedChain

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

void

void assertDoesntHaveChain()

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

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

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 $e

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

void
END_OF_DOCUMENT_MARKER

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/11.x/Illuminate/Events/CallQueuedListener.html

Spec-Zone.ru

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