86 lines
2.2 KiB
PHP
86 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace BeyondCode\LaravelWebSockets\PubSub;
|
|
|
|
use stdClass;
|
|
use React\EventLoop\LoopInterface;
|
|
use React\Promise\PromiseInterface;
|
|
|
|
interface ReplicationInterface
|
|
{
|
|
/**
|
|
* Boot the pub/sub provider (open connections, initial subscriptions, etc).
|
|
*
|
|
* @param LoopInterface $loop
|
|
* @return self
|
|
*/
|
|
public function boot(LoopInterface $loop): self;
|
|
|
|
/**
|
|
* Publish a payload on a specific channel, for a specific app.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @param stdClass $payload
|
|
* @return bool
|
|
*/
|
|
public function publish(string $appId, string $channel, stdClass $payload): bool;
|
|
|
|
/**
|
|
* Subscribe to receive messages for a channel.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @return bool
|
|
*/
|
|
public function subscribe(string $appId, string $channel): bool;
|
|
|
|
/**
|
|
* Unsubscribe from a channel.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @return bool
|
|
*/
|
|
public function unsubscribe(string $appId, string $channel): bool;
|
|
|
|
/**
|
|
* Add a member to a channel. To be called when they have
|
|
* subscribed to the channel.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @param string $socketId
|
|
* @param string $data
|
|
*/
|
|
public function joinChannel(string $appId, string $channel, string $socketId, string $data);
|
|
|
|
/**
|
|
* Remove a member from the channel. To be called when they have
|
|
* unsubscribed from the channel.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @param string $socketId
|
|
*/
|
|
public function leaveChannel(string $appId, string $channel, string $socketId);
|
|
|
|
/**
|
|
* Retrieve the full information about the members in a presence channel.
|
|
*
|
|
* @param string $appId
|
|
* @param string $channel
|
|
* @return PromiseInterface
|
|
*/
|
|
public function channelMembers(string $appId, string $channel): PromiseInterface;
|
|
|
|
/**
|
|
* Get the amount of users subscribed for each presence channel.
|
|
*
|
|
* @param string $appId
|
|
* @param array $channelNames
|
|
* @return PromiseInterface
|
|
*/
|
|
public function channelMemberCounts(string $appId, array $channelNames): PromiseInterface;
|
|
}
|