Split payload handling logic out

So that it can be used client-side too

Author: dominics

lib/Wrench/Connection.php

@@ -2,6 +2,8 @@
 
 namespace Wrench;
 
+use Wrench\Payload\PayloadHandler;
+
 use Wrench\Protocol\Protocol;
 
 use Wrench\Payload\Payload;
@@ -37,7 +39,7 @@ class Connection extends Configurable
      *
      * Wraps the client connection resource
      *
-     * @var Socket
+     * @var ServerClientSocket
      */
     protected $socket;
 
@@ -77,9 +79,9 @@ class Connection extends Configurable
     protected $id = null;
 
     /**
-     * The current payload
+     * @var PayloadHandler
      */
-    protected $payload;
+    protected $payloadHandler;
 
     /**
      * Constructor
@@ -97,9 +99,11 @@ public function __construct(
         $this->manager = $manager;
         $this->socket = $socket;
 
+
         parent::__construct($options);
 
         $this->configureClientInformation();
+        $this->configurePayloadHandler();
 
         $this->log('Connected');
     }
@@ -127,6 +131,14 @@ protected function configure(array $options)
         parent::configure($options);
     }
 
+    protected function configurePayloadHandler()
+    {
+        $this->payloadHandler = new PayloadHandler(
+            array($this, 'handlePayload'),
+            $this->options
+        );
+    }
+
     /**
      * @throws RuntimeException
      */
@@ -266,62 +278,27 @@ protected function export($data)
      * @todo An endpoint MUST be capable of handling control frames in the
      *        middle of a fragmented message.
      * @param string $data
+     * @return void
      */
     public function handle($data)
     {
-        if (!$this->payload) {
-            $this->payload = $this->protocol->getPayload();
-        }
-
-        while ($data) { // Each iteration pulls off a single payload chunk
-            $size = strlen($data);
-            $remaining = $this->payload->getRemainingData();
-
-            // If we don't yet know how much data is remaining, read data into
-            // the payload in two byte chunks (the size of a WebSocket frame
-            // header to get the initial length)
-            //
-            // Then re-loop. For extended lengths, this will happen once or four
-            // times extra, as the extended length is read in.
-            if ($remaining === null) {
-                $chunk_size = 2;
-            } elseif ($remaining > 0) {
-                $chunk_size = $remaining;
-            } elseif ($remaining === 0) {
-                $chunk_size = 0;
-            }
-
-            $chunk_size = min(strlen($data), $chunk_size);
-            $chunk = substr($data, 0, $chunk_size);
-            $data = substr($data, $chunk_size);
-
-            $this->payload->receiveData($chunk);
-
-            if ($remaining !== 0 && !$this->payload->isComplete()) {
-                continue;
-            }
-
-            if ($this->payload->isComplete()) {
-                $this->handlePayload($this->payload);
-                $this->payload = $this->protocol->getPayload();
-            } else {
-                throw new ConnectionException('Payload will not complete');
-            }
-        }
+        $this->payloadHandler->handle($data);
     }
 
     /**
      * Handle a complete payload received from the client
      *
+     * Public because called from our PayloadHandler
+     *
      * @param string $payload
      */
-    protected function handlePayload(Payload $payload)
+    public function handlePayload(Payload $payload)
     {
         $app = $this->getClientApplication();
 
         $this->log('Handling payload: ' . $payload->getPayload(), 'debug');
 
-        switch ($payload->getType()) {
+        switch ($type = $payload->getType()) {
             case Protocol::TYPE_TEXT:
                 if (method_exists($app, 'onData')) {
                     $app->onData($payload, $this);

lib/Wrench/Payload/PayloadHandler.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace Wrench\Payload;
+
+use Wrench\Exception\PayloadException;
+use Wrench\Exception\ConnectionException;
+use Wrench\Util\Configurable;
+use \InvalidArgumentException;
+
+/**
+ * Handles chunking and splitting of payloads into frames
+ */
+class PayloadHandler extends Configurable
+{
+    /**
+     * A callback that will be called when a complete payload is available
+     *
+     * @var callable
+     */
+    protected $callback;
+
+    /**
+     * The current payload
+     */
+    protected $payload;
+
+    /**
+     * @param callable $callback
+     * @param array $options
+     * @throws InvalidArgumentException
+     */
+    public function __construct($callback, array $options = array())
+    {
+        parent::__construct($options);
+
+        if (!is_callable($callback)) {
+            throw new InvalidArgumentException('You must supply a callback to PayloadHandler');
+        }
+
+        $this->callback = $callback;
+    }
+
+    /**
+     * Handles the raw socket data given
+     *
+     * @param string $data
+     */
+    public function handle($data)
+    {
+        if (!$this->payload) {
+            $this->payload = $this->protocol->getPayload();
+        }
+
+        while ($data) { // Each iteration pulls off a single payload chunk
+            $size = strlen($data);
+            $remaining = $this->payload->getRemainingData();
+
+            // If we don't yet know how much data is remaining, read data into
+            // the payload in two byte chunks (the size of a WebSocket frame
+            // header to get the initial length)
+            //
+            // Then re-loop. For extended lengths, this will happen once or four
+            // times extra, as the extended length is read in.
+            if ($remaining === null) {
+                $chunk_size = 2;
+            } elseif ($remaining > 0) {
+                $chunk_size = $remaining;
+            } elseif ($remaining === 0) {
+                $chunk_size = 0;
+            }
+
+            $chunk_size = min(strlen($data), $chunk_size);
+            $chunk = substr($data, 0, $chunk_size);
+            $data = substr($data, $chunk_size);
+
+            $this->payload->receiveData($chunk);
+
+            if ($remaining !== 0 && !$this->payload->isComplete()) {
+                continue;
+            }
+
+            if ($this->payload->isComplete()) {
+                $this->emit($this->payload);
+                $this->payload = $this->protocol->getPayload();
+            } else {
+                throw new PayloadException('Payload will not complete');
+            }
+        }
+    }
+
+    /**
+     * Emits a complete payload to the callback
+     *
+     * @param Payload $payload
+     */
+    protected function emit(Payload $payload)
+    {
+        call_user_func($this->callback, $payload);
+    }
+}