BroadcastManager
class BroadcastManager implements Factory mixin Broadcaster (View source)
Properties
| protected Container | $app | The application instance. |
|
| protected array | $drivers | The array of resolved broadcast drivers. |
|
| protected array | $customCreators | The registered custom driver creators. |
Methods
Register the routes for handling broadcast channel authentication and sockets.
Register the routes for handling broadcast user authentication.
Register the routes for handling broadcast authentication and sockets.
Begin broadcasting an event.
Queue the given event for broadcast.
Determine if the broadcastable event must be unique and determine if we can acquire the necessary lock.
Get a driver instance.
Get a driver instance.
Attempt to get the connection from the local cache.
Resolve the given broadcaster.
Call a custom driver creator.
Create an instance of the driver.
Get a Pusher instance for the given configuration.
Create an instance of the driver.
Get an Ably instance for the given configuration.
Create an instance of the driver.
Create an instance of the driver.
Create an instance of the driver.
Get the connection configuration.
Get the default driver name.
Set the default driver name.
Disconnect the given disk and remove from local cache.
Get the application instance used by the manager.
Forget all of the resolved driver instances.
Dynamically call the default driver instance.
Details
void
__construct(Container $app)
Create a new manager instance.
void
routes(array|null $attributes = null)
Register the routes for handling broadcast channel authentication and sockets.
void
userRoutes(array|null $attributes = null)
Register the routes for handling broadcast user authentication.
void
channelRoutes(array|null $attributes = null)
Register the routes for handling broadcast authentication and sockets.
Alias of "routes" method.
string|null
socket(Request|null $request = null)
Get the socket ID for the given request.
PendingBroadcast
event(mixed|null $event = null)
Begin broadcasting an event.
void
queue(mixed $event)
Queue the given event for broadcast.
protected bool
mustBeUniqueAndCannotAcquireLock(mixed $event)
Determine if the broadcastable event must be unique and determine if we can acquire the necessary lock.
Broadcaster
connection(string|null $driver = null)
Get a driver instance.
mixed
driver(string|null $name = null)
Get a driver instance.
protected Broadcaster
get(string $name)
Attempt to get the connection from the local cache.
protected Broadcaster
resolve(string $name)
Resolve the given broadcaster.
protected mixed
callCustomCreator(array $config)
Call a custom driver creator.
protected Broadcaster
createPusherDriver(array $config)
Create an instance of the driver.
Pusher
pusher(array $config)
Get a Pusher instance for the given configuration.
protected Broadcaster
createAblyDriver(array $config)
Create an instance of the driver.
AblyRest
ably(array $config)
Get an Ably instance for the given configuration.
protected Broadcaster
createRedisDriver(array $config)
Create an instance of the driver.
protected Broadcaster
createLogDriver(array $config)
Create an instance of the driver.
protected Broadcaster
createNullDriver(array $config)
Create an instance of the driver.
protected array
getConfig(string $name)
Get the connection configuration.
string
getDefaultDriver()
Get the default driver name.
void
setDefaultDriver(string $name)
Set the default driver name.
void
purge(string|null $name = null)
Disconnect the given disk and remove from local cache.
$this
extend(string $driver, Closure $callback)
Register a custom driver creator Closure.
Application
getApplication()
Get the application instance used by the manager.
$this
setApplication(Application $app)
Set the application instance used by the manager.
$this
forgetDrivers()
Forget all of the resolved driver instances.
mixed
__call(string $method, array $parameters)
Dynamically call the default driver instance.