Rationalize API renaming or moving stuff in Predis\Protocol namespace.

2026-10-17 17:25:56 +00:00 · 2013-11-09 17:40:38 +01:00
parent 16d17af577
commit 9136033eea
25 changed files with 95 additions and 100 deletions
@@ -0,0 +1,140 @@
+<?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\ResponseError;
+use Predis\ResponseQueued;
+use Predis\Command\CommandInterface;
+use Predis\Connection\ComposableConnectionInterface;
+use Predis\Iterator\MultiBulkResponseSimple;
+use Predis\Protocol\ProtocolException;
+use Predis\Protocol\ProtocolProcessorInterface;
+
+/**
+ * Protocol processor for the standard Redis wire protocol.
+ *
+ * @link http://redis.io/topics/protocol
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class ProtocolProcessor implements ProtocolProcessorInterface
+{
+    const NEWLINE = "\r\n";
+    const OK      = 'OK';
+    const ERROR   = 'ERR';
+    const QUEUED  = 'QUEUED';
+    const NULL    = 'nil';
+
+    const PREFIX_STATUS     = '+';
+    const PREFIX_ERROR      = '-';
+    const PREFIX_INTEGER    = ':';
+    const PREFIX_BULK       = '$';
+    const PREFIX_MULTI_BULK = '*';
+
+    const BUFFER_SIZE = 4096;
+
+    private $mbiterable;
+    private $serializer;
+
+    /**
+     *
+     */
+    public function __construct()
+    {
+        $this->mbiterable = false;
+        $this->serializer = new RequestSerializer();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write(ComposableConnectionInterface $connection, CommandInterface $command)
+    {
+        $connection->writeBytes($this->serializer->serialize($command));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read(ComposableConnectionInterface $connection)
+    {
+        $chunk = $connection->readLine();
+        $prefix = $chunk[0];
+        $payload = substr($chunk, 1);
+
+        switch ($prefix) {
+            case '+':    // inline
+                switch ($payload) {
+                    case 'OK':
+                        return true;
+
+                    case 'QUEUED':
+                        return new ResponseQueued();
+
+                    default:
+                        return $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 MultiBulkResponseSimple($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 ResponseError($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;
+    }
+}