Spec-Zone.ru › Laravel 10

BroadcastManager

класс BroadcastManager реализует Factory микcин Broadcaster (Просмотреть исходный код)

Свойства

protected Container $app

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

protected массив $drivers

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

protected массив $customCreators

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

Методы

void __construct(Container $app)

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

void routes(array $attributes = null)

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

void userRoutes(array $attributes = null)

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

void channelRoutes(array $attributes = null)

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

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)

Разрешить указанный броадкастер.

mixed callCustomCreator(array $config)

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

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

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

Details

void __construct(Container $app)

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

Parameters

Container $app

Return Value

void

void routes(array $attributes = null)

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

Parameters

array $attributes

Return Value

void

void userRoutes(array $attributes = null)

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

Parameters

array $attributes

Return Value

void

void channelRoutes(array $attributes = null)

Регистрация маршрутов для обработки аутентификации широковещательной передачи и сокетов.

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

Параметры

array $attributes

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

void

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

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

Параметры

Request|null $request

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

string|null

PendingBroadcast event(mixed|null $event = null)

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

Параметры

mixed|null $event

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

PendingBroadcast

void queue(mixed $event)

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

Параметры

mixed $event

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

void

protected bool mustBeUniqueAndCannotAcquireLock(mixed $event)

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

Параметры

mixed $event

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

bool

Broadcaster connection(string|null $driver = null)

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

Параметры

string|null $driver

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

Broadcaster

mixed driver(string|null $name = null)

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

Параметры

string|null $name

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

mixed

protected Broadcaster get(string $name)

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

Параметры

string $name

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

Broadcaster

protected Broadcaster resolve(string $name)

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

Параметры

string $name

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

Broadcaster

Исключения

InvalidArgumentException

protected mixed callCustomCreator(array $config)

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

Параметры

массив $config

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

смешанный

protected Broadcaster createReverbDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

protected Broadcaster createPusherDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

Pusher pusher(array $config)

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

Параметры

массив $config

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

Pusher

protected Broadcaster createAblyDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

AblyRest ably(array $config)

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

Параметры

массив $config

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

AblyRest

protected Broadcaster createRedisDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

protected Broadcaster createLogDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

protected Broadcaster createNullDriver(array $config)

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

Параметры

массив $config

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

Broadcaster

protected array getConfig(string $name)

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

Параметры

string $name

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

array

string getDefaultDriver()

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

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

string

void setDefaultDriver(string $name)

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

Параметры

string $name

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

void

void purge(string|null $name = null)

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

Параметры

string|null $name

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

void

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

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

Параметры

string $driver
Closure $callback

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

$this

Application getApplication()

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

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

Application

$this setApplication(Application $app)

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

Параметры

Application $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/10.x/Illuminate/Broadcasting/BroadcastManager.html

Spec-Zone.ru

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