BroadcastManager

class BroadcastManager implements Factory mixin Broadcaster (View source)

Свойства

protected Container	$app	Экземпляр приложения.
protected array	$drivers	Массив разрешенных драйверов вещания.
protected array	$customCreators	Зарегистрированные создатели пользовательских драйверов.

Методы

void

__construct(Container $app)

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

void

routes(array|null $attributes = null)

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

void

userRoutes(array|null $attributes = null)

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

void

channelRoutes(array|null $attributes = null)

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

string|null

socket(Request|null $request = null)

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

AnonymousEvent

on(Channel|string|array $channels)

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

AnonymousEvent

private(string $channel)

Начать отправку анонимного вещания на заданные частные каналы.

AnonymousEvent

presence(string $channel)

Начать отправку анонимного вещания на заданные каналы присутствия.

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|null $attributes = null)

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

Parameters

array|null

$attributes

Return Value

void

void userRoutes(array|null $attributes = null)

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

Параметры

array|null

$attributes

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

void

void channelRoutes(array|null $attributes = null)

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

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

Параметры

array|null

$attributes

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

void

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

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

Параметры

Request|null

$request

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

string|null

AnonymousEvent on(Channel|string|array $channels)

Начало отправки анонимного широковещательного сообщения на заданные каналы.

Параметры

Channel|string|array

$channels

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

AnonymousEvent

AnonymousEvent private(string $channel)

Начало отправки анонимного широковещательного сообщения на заданные частные каналы.

Параметры

string

$channel

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

AnonymousEvent

AnonymousEvent presence(string $channel)

Начало отправки анонимного широковещательного сообщения на заданные каналы присутствия.

Параметры

string

$channel

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

AnonymousEvent

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)

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

Параметры

array

$config

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

mixed

protected Broadcaster createReverbDriver(array $config)

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

Параметры

array

$config

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

Broadcaster

protected Broadcaster createPusherDriver(array $config)

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

Параметры

array

$config

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

Broadcaster

Pusher pusher(array $config)

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

Параметры

array

$config

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

Pusher

protected Broadcaster createAblyDriver(array $config)

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

Параметры

array

$config

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

Broadcaster

AblyRest ably(array $config)

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

Параметры

array

$config

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

AblyRest

protected Broadcaster createRedisDriver(array $config)

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

Параметры

array

$config

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

Broadcaster

protected Broadcaster createLogDriver(array $config)

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

Параметры

array

$config

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

Broadcaster

protected Broadcaster createNullDriver(array $config)

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

Параметры

array

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

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

Параметры

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/11.x/Illuminate/Broadcasting/BroadcastManager.html