Spec-Zone.ru › Laravel 9

BroadcastManager

class BroadcastManager implements Factory mixin Broadcaster (View source)

Свойства

protected Container $app

Экземпляр приложения.

protected array $drivers

Массив разрешённых драйверов broadcast.

protected array $customCreators

Зарегистрированные создатели пользовательских драйверов.

Методы

void __construct(Container $app)

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

void routes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации каналов broadcast и сокетов.

void userRoutes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации пользователей broadcast.

void channelRoutes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации и сокетов broadcast.

string|null socket(Request|null $request = null)

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

PendingBroadcast event(mixed|null $event = null)

Начать трансляцию события.

void queue(mixed $event)

Поместить данное событие в очередь для трансляции.

bool mustBeUniqueAndCannotAcquireLock(mixed $event)

Определить, должно ли транслируемое событие быть уникальным, и определить, можем ли мы получить необходимый замок.

Broadcaster connection(string|null $driver = null)

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

mixed driver(string|null $name = null)

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

Broadcaster get(string $name)

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

Broadcaster resolve(string $name)

Разрешить данный broadcaster.

mixed callCustomCreator(array $config)

Вызвать создателя пользовательского драйвера.

Broadcaster createPusherDriver(array $config)

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

Pusher pusher(array $config)

Получить экземпляр Pusher для данной конфигурации.

Broadcaster createAblyDriver(array $config)

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

AblyRest ably(array $config)

Получить экземпляр Ably для данной конфигурации.

Broadcaster createRedisDriver(array $config)

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

Broadcaster createLogDriver(array $config)

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

Broadcaster createNullDriver(array $config)

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

array getConfig(string $name)

Получить конфигурацию соединения.

string getDefaultDriver()

Получить имя драйвера по умолчанию.

void setDefaultDriver(string $name)

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

void purge(string|null $name = null)

Отключить заданный диск и удалить его из локального кэша.

$this extend(string $driver, Closure $callback)

Зарегистрировать пользовательского создателя драйвера Closure.

Application getApplication()

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

$this setApplication(Application $app)

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

$this forgetDrivers()

Забыть все решенные экземпляры драйвера.

mixed __call(string $method, array $parameters)

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

Подробности

void __construct(Container $app)

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

Параметры

Container $app

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

void

void routes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации каналов broadcast и сокетов.

Параметры

array $attributes

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

void

void userRoutes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации пользователей broadcast.

Параметры

array $attributes

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

void

void channelRoutes(array $attributes = null)

Зарегистрировать маршруты для обработки аутентификации и сокетов broadcast.

Псевдоним метода "routes".

Параметры

array $attributes

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

void

строка|null socket(Запрос|null $request = null)

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

Параметры

Запрос|null $request

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

строка|null

ОтложенноеВещание event(смешанный|null $event = null)

Начать вещание события.

Параметры

смешанный|null $event

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

ОтложенноеВещание

пусто queue(смешанный $event)

Поместить данное событие в очередь для вещания.

Параметры

смешанный $event

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

пусто

protected логическое mustBeUniqueAndCannotAcquireLock(смешанный $event)

Определить, должно ли транслируемое событие быть уникальным, и определить, можем ли мы получить необходимый замок.

Параметры

смешанный $event

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

логическое

Вещатель connection(строка|null $driver = null)

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

Параметры

строка|null $driver

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

Вещатель

смешанный driver(строка|null $name = null)

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

Параметры

строка|null $name

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

смешанный

protected Вещатель get(строка $name)

Попытка получить подключение из локального кэша.

Параметры

строка $name

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

Вещатель

protected Вещатель resolve(строка $name)

Разрешить указанного вещателя.

Параметры

строка $name

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

Вещатель

Исключения

ИсключениеНедействительногоАргумента

protected смешанный callCustomCreator(массив $config)

Вызвать пользовательского создателя драйвера.

Параметры

массив $config

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

смешанный

protected Вещатель createPusherDriver(массив $config)

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

Параметры

массив $config

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

Вещатель

Pusher pusher(массив $config)

Получить экземпляр Pusher для заданной конфигурации.

Параметры

массив $config

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

Pusher

protected Вещатель createAblyDriver(массив $config)

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

Параметры

массив $config

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

Вещатель

AblyRest ably(массив $config)

Получить экземпляр Ably для заданной конфигурации.

Параметры

массив $config

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

AblyRest

protected Вещатель createRedisDriver(массив $config)

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

Параметры

массив $config

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

Вещатель

protected Вещатель createLogDriver(массив $config)

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

Параметры

массив $config

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

Вещатель

protected Вещатель createNullDriver(массив $config)

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

Параметры

массив $config

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

Вещатель

protected массив getConfig(строка $name)

Получить конфигурацию подключения.

Параметры

строка $name

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

массив

строка getDefaultDriver()

Получить имя драйвера по умолчанию.

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

строка

пусто setDefaultDriver(строка $name)

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

Параметры

строка $name

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

пусто

void purge(string|null $name = null)

Отключить указанный диск и удалить из локального кэша.

Параметры

string|null $name

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

void

$this extend(string $driver, Closure $callback)

Зарегистрировать Closure для создания пользовательского драйвера.

Параметры

string $driver
Closure $callback

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

$this

Приложение getApplication()

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

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

Приложение

$this setApplication(Приложение $app)

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

Параметры

Приложение $app

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

$this

$this forgetDrivers()

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

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

$this

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Broadcasting/BroadcastManager.html

Spec-Zone.ru

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