class BroadcastManager implements Factory mixin Broadcaster (View source)

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.

event(mixed|null $event = null)

Begin broadcasting an event.

void
queue(mixed $event)

Queue the given event for broadcast.

void
connection(string|null $driver = null)

Get a driver instance.

mixed
driver(string|null $name = null)

Get a driver instance.

get(string $name)

Attempt to get the connection from the local cache.

resolve(string $name)

Resolve the given broadcaster.

mixed
callCustomCreator(array $config)

Call a custom driver creator.

createPusherDriver(array $config)

Create an instance of the driver.

createRedisDriver(array $config)

Create an instance of the driver.

createLogDriver(array $config)

Create an instance of the driver.

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

void __construct(Application $app)

Create a new manager instance.

Parameters

Application $app

Return Value

void

void routes(array $attributes = null)

Register the routes for handling broadcast authentication and sockets.

Parameters

array $attributes

Return Value

void

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

Get the socket ID for the given request.

Parameters

Request|null $request

Return Value

string|null

PendingBroadcast event(mixed|null $event = null)

Begin broadcasting an event.

Parameters

mixed|null $event

Return Value

PendingBroadcast

void queue(mixed $event)

Queue the given event for broadcast.

Parameters

mixed $event

Return Value

void

void connection(string|null $driver = null)

Get a driver instance.

Parameters

string|null $driver

Return Value

void

mixed driver(string|null $name = null)

Get a driver instance.

Parameters

string|null $name

Return Value

mixed

protected Broadcaster get(string $name)

Attempt to get the connection from the local cache.

Parameters

string $name

Return Value

Broadcaster

protected Broadcaster resolve(string $name)

Resolve the given broadcaster.

Parameters

string $name

Return Value

Broadcaster

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(array $config)

Call a custom driver creator.

Parameters

array $config

Return Value

mixed

protected Broadcaster createPusherDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

protected Broadcaster createRedisDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

protected Broadcaster createLogDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

protected Broadcaster createNullDriver(array $config)

Create an instance of the driver.

Parameters

array $config

Return Value

Broadcaster

protected array getConfig(string $name)

Get the connection configuration.

Parameters

string $name

Return Value

array

string getDefaultDriver()

Get the default driver name.

Return Value

string

void setDefaultDriver(string $name)

Set the default driver name.

Parameters

string $name

Return Value

void

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

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.