Spec-Zone.ru › Laravel 10

BroadcastEvent

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

Свойства

Queueable

Свойства

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
mixed $event

Экземпляр события.

int $tries

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

int $timeout

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

int $backoff

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

int $maxExceptions

Максимальное количество необработанных исключений, которые разрешены перед завершением с ошибкой.

Методы

$this onConnection(string|null $connection)

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

из Queueable
$this onQueue(string|null $queue)

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

из Queueable
$this allOnConnection(string|null $connection)

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

из Queueable
$this allOnQueue(string|null $queue)

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

из Queueable
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

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

из Queueable
$this afterCommit()

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

из Queueable
$this beforeCommit()

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

из Queueable
$this through(array|object $middleware)

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

из Queueable
$this chain(array $chain)

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

из Queueable
$this prependToChain(mixed $job)

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

из Queueable
$this appendToChain(mixed $job)

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

из Queueable
string serializeJob(mixed $job)

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

из Queueable
void dispatchNextJobInChain()

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

из Queueable
void invokeChainCatchCallbacks(Throwable $e)

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

из Queueable
void __construct(mixed $event)

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

void handle(Factory $manager)

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

array getPayloadFromEvent(mixed $event)

Получить данные для данного события.

mixed formatProperty(mixed $value)

Отформатировать заданное значение для свойства.

string displayName()

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

void __clone()

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

Подробности

$this onConnection(string|null $connection)

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

Parameters

string|null $connection

Return Value

$this
END_OF_DOCUMENT_MARKER

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

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

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

$this

$this beforeCommit()

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

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

$this

$this through(array|object $middleware)

Укажите, через какой 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 __construct(mixed $event)

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

Параметры

mixed $event

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

void

void handle(Factory $manager)

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

Параметры

Factory $manager

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

void

protected array getPayloadFromEvent(mixed $event)

Получить данные для данного события.

Параметры

mixed $event

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

array

protected mixed formatProperty(mixed $value)

Отформатировать заданное значение для свойства.

Параметры

mixed $value

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

mixed

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/Broadcasting/BroadcastEvent.html

Spec-Zone.ru

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