1. interface
  2. Hypervel
  3. \
  4. Reverb
  5. \
  6. Protocols
  7. \
  8. Pusher
  9. \
  10. Contracts
  11. \
  12. ScopedChannelManager

ScopedChannelManager

interface ScopedChannelManager

Methods

Application
app()

Get the application instance.

array
all()

Get all the channels.

bool
exists(string $channel)

Determine whether the given channel exists.

Channel|null
find(string $channel)

Find the given channel.

Channel
findOrCreate(string $channel)

Find the given channel or create it if it doesn't exist.

array
connections(string|null $channel = null)

Get all connections for the given channels.

ChannelConnection|null
findConnection(string $socketId)

Find a connection by its socket ID.

void
unsubscribeFromAll(Connection $connection)

Unsubscribe from all channels.

void
remove(Channel $channel)

Remove the given channel.

Details

at line 17
Application app()

Get the application instance.

Return Value

Application

at line 24
array all()

Get all the channels.

Return Value

array

at line 29
bool exists(string $channel)

Determine whether the given channel exists.

Parameters

string $channel

Return Value

bool

at line 34
Channel|null find(string $channel)

Find the given channel.

Parameters

string $channel

Return Value

Channel|null

at line 39
Channel findOrCreate(string $channel)

Find the given channel or create it if it doesn't exist.

Parameters

string $channel

Return Value

Channel

at line 46
array connections(string|null $channel = null)

Get all connections for the given channels.

Parameters

string|null $channel

Return Value

array

at line 51
ChannelConnection|null findConnection(string $socketId)

Find a connection by its socket ID.

Parameters

string $socketId

Return Value

ChannelConnection|null

at line 56
void unsubscribeFromAll(Connection $connection)

Unsubscribe from all channels.

Parameters

Connection $connection

Return Value

void

at line 61
void remove(Channel $channel)

Remove the given channel.

Parameters

Channel $channel

Return Value

void