1. class
  2. Illuminate
  3. \
  4. Broadcasting
  5. \
  6. BroadcastManager

BroadcastManager

class BroadcastManager implements Factory mixin Broadcaster

Properties

protected Application $app

The application instance.
protected array $drivers

The array of resolved broadcast drivers.
protected array $customCreators

The registered custom driver creators.

Methods

void
__construct(Application $app)

Create a new manager instance.

void
routes(array $attributes = null)

Register the routes for handling broadcast authentication and sockets.

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

Get the socket ID for the given request.

PendingBroadcast|void
event(mixed|null $event = null)

Begin broadcasting an event.

void
queue(mixed $event)

Queue the given event for broadcast.

void
connection(string $driver = null)

Get a driver instance.

mixed
driver(string $name = null)

Get a driver instance.

Broadcaster
get(string $name)

Attempt to get the connection from the local cache.

Broadcaster
resolve(string $name)

Resolve the given store.

mixed
callCustomCreator(array $config)

Call a custom driver creator.

Broadcaster
createPusherDriver(array $config)

Create an instance of the driver.

Broadcaster
createRedisDriver(array $config)

Create an instance of the driver.

Broadcaster
createLogDriver(array $config)

Create an instance of the driver.

Broadcaster
createNullDriver(array $config)

Create an instance of the driver.

array
getConfig(string $name)

Get the connection configuration.

string
getDefaultDriver()

Get the default driver name.

void
setDefaultDriver(string $name)

Set the default driver name.

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

Register a custom driver creator Closure.

mixed
__call(string $method, array $parameters)

Dynamically call the default driver instance.

Details

at line 49
void __construct(Application $app)

Create a new manager instance.

Parameters

Application $app

Return Value

void

at line 60
void routes(array $attributes = null)

Register the routes for handling broadcast authentication and sockets.

Parameters

array $attributes

Return Value

void

at line 79
string|null socket(Request|null $request = null)

Get the socket ID for the given request.

Parameters

Request|null $request

Return Value

string|null

at line 98
PendingBroadcast|void event(mixed|null $event = null)

Begin broadcasting an event.

Parameters

mixed|null $event

Return Value

PendingBroadcast|void

at line 109
void queue(mixed $event)

Queue the given event for broadcast.

Parameters

mixed $event

Return Value

void

at line 138
void connection(string $driver = null)

Get a driver instance.

Parameters

string $driver

Return Value

void

at line 149
mixed driver(string $name = null)

Get a driver instance.

Parameters

string $name

Return Value

mixed

at line 162
protected Broadcaster get(string $name)

Attempt to get the connection from the local cache.

Parameters

string $name

Return Value

Broadcaster

at line 175
protected Broadcaster resolve(string $name)

Resolve the given store.

Parameters

string $name

Return Value

Broadcaster

Exceptions

InvalidArgumentException

at line 202
protected mixed callCustomCreator(array $config)

Call a custom driver creator.

Parameters

array $config

Return Value

mixed

at line 213
protected Broadcaster createPusherDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

at line 227
protected Broadcaster createRedisDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

at line 240
protected Broadcaster createLogDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

at line 253
protected Broadcaster createNullDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

at line 264
protected array getConfig(string $name)

Get the connection configuration.

Parameters

string $name

Return Value

array

at line 274
string getDefaultDriver()

Get the default driver name.

Return Value

string

at line 285
void setDefaultDriver(string $name)

Set the default driver name.

Parameters

string $name

Return Value

void

at line 297
$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

at line 311
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed