RedisBroadcaster

class RedisBroadcaster extends Broadcaster (View source)

Properties

protected array $channels The registered channel authenticators. from Broadcaster
protected Database $redis The Redis instance.
protected string $connection The Redis connection to use for broadcasting.

Methods

$this channel(string $channel, callable $callback)

Register a channel authenticator.

 from Broadcaster
mixed verifyUserCanAccessChannel(Request $request, string $channel)

Authenticate the incoming request for a given channel.

 from Broadcaster
array extractAuthParameters(string $pattern, string $channel)

Extract the parameters from the given pattern and channel.

 from Broadcaster
array formatChannels(array $channels)

Format the channel array into an array of strings.

 from Broadcaster
void __construct(Database $redis, string $connection = null)

Create a new broadcaster instance.
mixed auth(Request $request)

Authenticate the incoming request for a given channel.
mixed validAuthenticationResponse(Request $request, mixed $result)

Return the valid authentication response.
void broadcast(array $channels, string $event, array $payload = [])

Broadcast the given event.

Details

$this channel(string $channel, callable $callback)

Register a channel authenticator.

Parameters

string $channel
callable $callback

Return Value

$this

protected mixed verifyUserCanAccessChannel(Request $request, string $channel)

Authenticate the incoming request for a given channel.

Parameters

Request $request
string $channel

Return Value

mixed

protected array extractAuthParameters(string $pattern, string $channel)

Extract the parameters from the given pattern and channel.

Parameters

string $pattern
string $channel

Return Value

array

protected array formatChannels(array $channels)

Format the channel array into an array of strings.

Parameters

array $channels

Return Value

array

void __construct(Database $redis, string $connection = null)

Create a new broadcaster instance.

Parameters

Database $redis
string $connection

Return Value

void

mixed auth(Request $request)

Authenticate the incoming request for a given channel.

Parameters

Request $request

Return Value

mixed

mixed validAuthenticationResponse(Request $request, mixed $result)

Return the valid authentication response.

Parameters

Request $request
mixed $result

Return Value

mixed

void broadcast(array $channels, string $event, array $payload = [])

Broadcast the given event.

Parameters

array $channels
string $event
array $payload

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html