mirror of
https://github.com/predis/predis.git
synced 2026-08-27 10:34:10 +00:00
Daniele Alessandri
373d30b070
Status response objects are needed mostly to make it possible from the
client perspective to differentiate a status response with the payload
"OK" from a normale bulk reply containing "OK".
The biggest change is for commands returning +OK responses: these were
previously translated to TRUE (bool value), but they are now returned
as instances of Predis\Response\Status. Just to illustrate an example
of the possibilities with this change we will use SET since it is the
most widely used command returning +OK:
$response = $client->set('foo', 'bar');
echo $response; // 'OK'
$response == 'OK'; // TRUE
isset($response->ok); // TRUE
$response == true; // TRUE
$response === true; // FALSE
$response instanceof Predis\Response\ObjectInterface; // TRUE
$response instanceof Predis\Response\Status; // TRUE
For those checking responses returned by commands such as SET or PONG,
the breaking change basically lies in the usage of strict comparison:
doing $response === true will now evaluate to FALSE instead of TRUE.
By default Predis caches common status responses such as OK or QUEUED
to lower the memory usage when using pipelines or transactions.
118 lines
3.2 KiB
PHP
118 lines
3.2 KiB
PHP
<?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\Protocol\Text;
|
|
|
|
use Predis\CommunicationException;
|
|
use Predis\Command\CommandInterface;
|
|
use Predis\Connection\ComposableConnectionInterface;
|
|
use Predis\Protocol\ProtocolException;
|
|
use Predis\Protocol\ProtocolProcessorInterface;
|
|
use Predis\Response;
|
|
use Predis\Response\Iterator;
|
|
|
|
/**
|
|
* Protocol processor for the standard Redis wire protocol.
|
|
*
|
|
* @link http://redis.io/topics/protocol
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
class ProtocolProcessor implements ProtocolProcessorInterface
|
|
{
|
|
protected $mbiterable;
|
|
protected $serializer;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->mbiterable = false;
|
|
$this->serializer = new RequestSerializer();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function write(ComposableConnectionInterface $connection, CommandInterface $command)
|
|
{
|
|
$request = $this->serializer->serialize($command);
|
|
$connection->writeBytes($request);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function read(ComposableConnectionInterface $connection)
|
|
{
|
|
$chunk = $connection->readLine();
|
|
$prefix = $chunk[0];
|
|
$payload = substr($chunk, 1);
|
|
|
|
switch ($prefix) {
|
|
case '+': // inline
|
|
return new Response\Status($payload);
|
|
|
|
case '$': // bulk
|
|
$size = (int) $payload;
|
|
if ($size === -1) {
|
|
return null;
|
|
}
|
|
return substr($connection->readBytes($size + 2), 0, -2);
|
|
|
|
case '*': // multi bulk
|
|
$count = (int) $payload;
|
|
|
|
if ($count === -1) {
|
|
return null;
|
|
}
|
|
if ($this->mbiterable) {
|
|
return new Iterator\MultiBulk($connection, $count);
|
|
}
|
|
|
|
$multibulk = array();
|
|
|
|
for ($i = 0; $i < $count; $i++) {
|
|
$multibulk[$i] = $this->read($connection);
|
|
}
|
|
|
|
return $multibulk;
|
|
|
|
case ':': // integer
|
|
return (int) $payload;
|
|
|
|
case '-': // error
|
|
return new Response\Error($payload);
|
|
|
|
default:
|
|
CommunicationException::handle(new ProtocolException(
|
|
$connection, "Unknown prefix: '$prefix'"
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enables or disables returning multibulk responses as specialized PHP
|
|
* iterators used to stream bulk elements of a multibulk response instead
|
|
* returning a plain array.
|
|
*
|
|
* Please note that streamable multibulk replies are not globally supported
|
|
* by the abstractions built-in into Predis such as for transactions or
|
|
* pipelines. Use them with care!
|
|
*
|
|
* @param bool $value Enable or disable streamable multibulk responses.
|
|
*/
|
|
public function useIterableMultibulk($value)
|
|
{
|
|
$this->mbiterable = (bool) $value;
|
|
}
|
|
}
|