Retwis ported to modern Redis data types.
The example (and related documentation at redis.io) was not updated for 5 years. Redis had no sorted sets and hashes when the original code was written (!). An update was really needed. We also use a modern PHP client now: Predis. A copy is shipped within this repository to make life easier to newcomers trying Redis for the first time via this example.
This commit is contained in:
antirez
commit
c58f935fdc
277 changed files with 18503 additions and 0 deletions
206
Predis/PubSub/AbstractPubSubContext.php
Normal file
206
Predis/PubSub/AbstractPubSubContext.php
Normal file
|
|
@ -0,0 +1,206 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the Predis package.
|
||||
*
|
||||
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Predis\PubSub;
|
||||
|
||||
/**
|
||||
* Client-side abstraction of a Publish / Subscribe context.
|
||||
*
|
||||
* @author Daniele Alessandri <suppakilla@gmail.com>
|
||||
*/
|
||||
abstract class AbstractPubSubContext implements \Iterator
|
||||
{
|
||||
const SUBSCRIBE = 'subscribe';
|
||||
const UNSUBSCRIBE = 'unsubscribe';
|
||||
const PSUBSCRIBE = 'psubscribe';
|
||||
const PUNSUBSCRIBE = 'punsubscribe';
|
||||
const MESSAGE = 'message';
|
||||
const PMESSAGE = 'pmessage';
|
||||
|
||||
const STATUS_VALID = 1; // 0b0001
|
||||
const STATUS_SUBSCRIBED = 2; // 0b0010
|
||||
const STATUS_PSUBSCRIBED = 4; // 0b0100
|
||||
|
||||
private $position = null;
|
||||
private $statusFlags = self::STATUS_VALID;
|
||||
|
||||
/**
|
||||
* Automatically closes the context when PHP's garbage collector kicks in.
|
||||
*/
|
||||
public function __destruct()
|
||||
{
|
||||
$this->closeContext(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the specified flag is valid in the state of the context.
|
||||
*
|
||||
* @param int $value Flag.
|
||||
* @return bool
|
||||
*/
|
||||
protected function isFlagSet($value)
|
||||
{
|
||||
return ($this->statusFlags & $value) === $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribes to the specified channels.
|
||||
*
|
||||
* @param mixed $channel,... One or more channel names.
|
||||
*/
|
||||
public function subscribe($channel /*, ... */)
|
||||
{
|
||||
$this->writeCommand(self::SUBSCRIBE, func_get_args());
|
||||
$this->statusFlags |= self::STATUS_SUBSCRIBED;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsubscribes from the specified channels.
|
||||
*
|
||||
* @param string ... One or more channel names.
|
||||
*/
|
||||
public function unsubscribe(/* ... */)
|
||||
{
|
||||
$this->writeCommand(self::UNSUBSCRIBE, func_get_args());
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribes to the specified channels using a pattern.
|
||||
*
|
||||
* @param mixed $pattern,... One or more channel name patterns.
|
||||
*/
|
||||
public function psubscribe($pattern /* ... */)
|
||||
{
|
||||
$this->writeCommand(self::PSUBSCRIBE, func_get_args());
|
||||
$this->statusFlags |= self::STATUS_PSUBSCRIBED;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsubscribes from the specified channels using a pattern.
|
||||
*
|
||||
* @param string ... One or more channel name patterns.
|
||||
*/
|
||||
public function punsubscribe(/* ... */)
|
||||
{
|
||||
$this->writeCommand(self::PUNSUBSCRIBE, func_get_args());
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the context by unsubscribing from all the subscribed channels.
|
||||
* Optionally, the context can be forcefully closed by dropping the
|
||||
* underlying connection.
|
||||
*
|
||||
* @param bool $force Forcefully close the context by closing the connection.
|
||||
* @return bool Returns false if there are no pending messages.
|
||||
*/
|
||||
public function closeContext($force = false)
|
||||
{
|
||||
if (!$this->valid()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($force) {
|
||||
$this->invalidate();
|
||||
$this->disconnect();
|
||||
} else {
|
||||
if ($this->isFlagSet(self::STATUS_SUBSCRIBED)) {
|
||||
$this->unsubscribe();
|
||||
}
|
||||
if ($this->isFlagSet(self::STATUS_PSUBSCRIBED)) {
|
||||
$this->punsubscribe();
|
||||
}
|
||||
}
|
||||
|
||||
return !$force;
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the underlying connection on forced disconnection.
|
||||
*/
|
||||
abstract protected function disconnect();
|
||||
|
||||
/**
|
||||
* Writes a Redis command on the underlying connection.
|
||||
*
|
||||
* @param string $method ID of the command.
|
||||
* @param array $arguments List of arguments.
|
||||
*/
|
||||
abstract protected function writeCommand($method, $arguments);
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function rewind()
|
||||
{
|
||||
// NOOP
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the last message payload retrieved from the server and generated
|
||||
* by one of the active subscriptions.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function current()
|
||||
{
|
||||
return $this->getValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function key()
|
||||
{
|
||||
return $this->position;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function next()
|
||||
{
|
||||
if ($this->valid()) {
|
||||
$this->position++;
|
||||
}
|
||||
|
||||
return $this->position;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the the context is still in a valid state to continue.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function valid()
|
||||
{
|
||||
$isValid = $this->isFlagSet(self::STATUS_VALID);
|
||||
$subscriptionFlags = self::STATUS_SUBSCRIBED | self::STATUS_PSUBSCRIBED;
|
||||
$hasSubscriptions = ($this->statusFlags & $subscriptionFlags) > 0;
|
||||
|
||||
return $isValid && $hasSubscriptions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets the state of the context.
|
||||
*/
|
||||
protected function invalidate()
|
||||
{
|
||||
$this->statusFlags = 0; // 0b0000;
|
||||
}
|
||||
|
||||
/**
|
||||
* Waits for a new message from the server generated by one of the active
|
||||
* subscriptions and returns it when available.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
abstract protected function getValue();
|
||||
}
|
||||
170
Predis/PubSub/DispatcherLoop.php
Normal file
170
Predis/PubSub/DispatcherLoop.php
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the Predis package.
|
||||
*
|
||||
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Predis\PubSub;
|
||||
|
||||
use Predis\ClientInterface;
|
||||
|
||||
/**
|
||||
* Method-dispatcher loop built around the client-side abstraction of a Redis
|
||||
* Publish / Subscribe context.
|
||||
*
|
||||
* @author Daniele Alessandri <suppakilla@gmail.com>
|
||||
*/
|
||||
class DispatcherLoop
|
||||
{
|
||||
private $pubSubContext;
|
||||
|
||||
protected $callbacks;
|
||||
protected $defaultCallback;
|
||||
protected $subscriptionCallback;
|
||||
|
||||
/**
|
||||
* @param ClientInterface $client Client instance used by the context.
|
||||
*/
|
||||
public function __construct(ClientInterface $client)
|
||||
{
|
||||
$this->callbacks = array();
|
||||
$this->pubSubContext = $client->pubSubLoop();
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the passed argument is a valid callback.
|
||||
*
|
||||
* @param mixed $callable A callback.
|
||||
*/
|
||||
protected function validateCallback($callable)
|
||||
{
|
||||
if (!is_callable($callable)) {
|
||||
throw new \InvalidArgumentException("A valid callable object must be provided");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the underlying Publish / Subscribe context.
|
||||
*
|
||||
* @return PubSubContext
|
||||
*/
|
||||
public function getPubSubContext()
|
||||
{
|
||||
return $this->pubSubContext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a callback that gets invoked upon new subscriptions.
|
||||
*
|
||||
* @param mixed $callable A callback.
|
||||
*/
|
||||
public function subscriptionCallback($callable = null)
|
||||
{
|
||||
if (isset($callable)) {
|
||||
$this->validateCallback($callable);
|
||||
}
|
||||
|
||||
$this->subscriptionCallback = $callable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a callback that gets invoked when a message is received on a
|
||||
* channel that does not have an associated callback.
|
||||
*
|
||||
* @param mixed $callable A callback.
|
||||
*/
|
||||
public function defaultCallback($callable = null)
|
||||
{
|
||||
if (isset($callable)) {
|
||||
$this->validateCallback($callable);
|
||||
}
|
||||
|
||||
$this->subscriptionCallback = $callable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Binds a callback to a channel.
|
||||
*
|
||||
* @param string $channel Channel name.
|
||||
* @param Callable $callback A callback.
|
||||
*/
|
||||
public function attachCallback($channel, $callback)
|
||||
{
|
||||
$callbackName = $this->getPrefixKeys() . $channel;
|
||||
|
||||
$this->validateCallback($callback);
|
||||
$this->callbacks[$callbackName] = $callback;
|
||||
$this->pubSubContext->subscribe($channel);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops listening to a channel and removes the associated callback.
|
||||
*
|
||||
* @param string $channel Redis channel.
|
||||
*/
|
||||
public function detachCallback($channel)
|
||||
{
|
||||
$callbackName = $this->getPrefixKeys() . $channel;
|
||||
|
||||
if (isset($this->callbacks[$callbackName])) {
|
||||
unset($this->callbacks[$callbackName]);
|
||||
$this->pubSubContext->unsubscribe($channel);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts the dispatcher loop.
|
||||
*/
|
||||
public function run()
|
||||
{
|
||||
foreach ($this->pubSubContext as $message) {
|
||||
$kind = $message->kind;
|
||||
|
||||
if ($kind !== PubSubContext::MESSAGE && $kind !== PubSubContext::PMESSAGE) {
|
||||
if (isset($this->subscriptionCallback)) {
|
||||
$callback = $this->subscriptionCallback;
|
||||
call_user_func($callback, $message);
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if (isset($this->callbacks[$message->channel])) {
|
||||
$callback = $this->callbacks[$message->channel];
|
||||
call_user_func($callback, $message->payload);
|
||||
} elseif (isset($this->defaultCallback)) {
|
||||
$callback = $this->defaultCallback;
|
||||
call_user_func($callback, $message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Terminates the dispatcher loop.
|
||||
*/
|
||||
public function stop()
|
||||
{
|
||||
$this->pubSubContext->closeContext();
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the prefix of the keys
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function getPrefixKeys()
|
||||
{
|
||||
$options = $this->pubSubContext->getClient()->getOptions();
|
||||
|
||||
if (isset($options->prefix)) {
|
||||
return $options->prefix->getPrefix();
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
}
|
||||
141
Predis/PubSub/PubSubContext.php
Normal file
141
Predis/PubSub/PubSubContext.php
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the Predis package.
|
||||
*
|
||||
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Predis\PubSub;
|
||||
|
||||
use Predis\ClientException;
|
||||
use Predis\ClientInterface;
|
||||
use Predis\Command\AbstractCommand as Command;
|
||||
use Predis\NotSupportedException;
|
||||
use Predis\Connection\AggregatedConnectionInterface;
|
||||
|
||||
/**
|
||||
* Client-side abstraction of a Publish / Subscribe context.
|
||||
*
|
||||
* @author Daniele Alessandri <suppakilla@gmail.com>
|
||||
*/
|
||||
class PubSubContext extends AbstractPubSubContext
|
||||
{
|
||||
private $client;
|
||||
private $options;
|
||||
|
||||
/**
|
||||
* @param ClientInterface $client Client instance used by the context.
|
||||
* @param array $options Options for the context initialization.
|
||||
*/
|
||||
public function __construct(ClientInterface $client, Array $options = null)
|
||||
{
|
||||
$this->checkCapabilities($client);
|
||||
$this->options = $options ?: array();
|
||||
$this->client = $client;
|
||||
|
||||
$this->genericSubscribeInit('subscribe');
|
||||
$this->genericSubscribeInit('psubscribe');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the underlying client instance used by the pub/sub iterator.
|
||||
*
|
||||
* @return ClientInterface
|
||||
*/
|
||||
public function getClient()
|
||||
{
|
||||
return $this->client;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the passed client instance satisfies the required conditions
|
||||
* needed to initialize a Publish / Subscribe context.
|
||||
*
|
||||
* @param ClientInterface $client Client instance used by the context.
|
||||
*/
|
||||
private function checkCapabilities(ClientInterface $client)
|
||||
{
|
||||
if ($client->getConnection() instanceof AggregatedConnectionInterface) {
|
||||
throw new NotSupportedException('Cannot initialize a PUB/SUB context when using aggregated connections');
|
||||
}
|
||||
|
||||
$commands = array('publish', 'subscribe', 'unsubscribe', 'psubscribe', 'punsubscribe');
|
||||
|
||||
if ($client->getProfile()->supportsCommands($commands) === false) {
|
||||
throw new NotSupportedException('The current profile does not support PUB/SUB related commands');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method shares the logic to handle both SUBSCRIBE and PSUBSCRIBE.
|
||||
*
|
||||
* @param string $subscribeAction Type of subscription.
|
||||
*/
|
||||
private function genericSubscribeInit($subscribeAction)
|
||||
{
|
||||
if (isset($this->options[$subscribeAction])) {
|
||||
$this->$subscribeAction($this->options[$subscribeAction]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function writeCommand($method, $arguments)
|
||||
{
|
||||
$arguments = Command::normalizeArguments($arguments);
|
||||
$command = $this->client->createCommand($method, $arguments);
|
||||
$this->client->getConnection()->writeCommand($command);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function disconnect()
|
||||
{
|
||||
$this->client->disconnect();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function getValue()
|
||||
{
|
||||
$response = $this->client->getConnection()->read();
|
||||
|
||||
switch ($response[0]) {
|
||||
case self::SUBSCRIBE:
|
||||
case self::UNSUBSCRIBE:
|
||||
case self::PSUBSCRIBE:
|
||||
case self::PUNSUBSCRIBE:
|
||||
if ($response[2] === 0) {
|
||||
$this->invalidate();
|
||||
}
|
||||
// The missing break here is intentional as we must process
|
||||
// subscriptions and unsubscriptions as standard messages.
|
||||
|
||||
case self::MESSAGE:
|
||||
return (object) array(
|
||||
'kind' => $response[0],
|
||||
'channel' => $response[1],
|
||||
'payload' => $response[2],
|
||||
);
|
||||
|
||||
case self::PMESSAGE:
|
||||
return (object) array(
|
||||
'kind' => $response[0],
|
||||
'pattern' => $response[1],
|
||||
'channel' => $response[2],
|
||||
'payload' => $response[3],
|
||||
);
|
||||
|
||||
default:
|
||||
$message = "Received an unknown message type {$response[0]} inside of a pubsub context";
|
||||
throw new ClientException($message);
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue