Merge pull request #141 from legionth/add-example

Add example to handle body data

Author: clue

README.md

@@ -92,6 +92,8 @@ See also [`Request`](#request) and [`Response`](#response) for more details.
 Failing to do so will result in the server parsing the incoming request,
 but never sending a response back to the client.
 
+Checkout [Request](#request) for details about the request data body.
+
 The `Server` supports both HTTP/1.1 and HTTP/1.0 request messages.
 If a client sends an invalid request message, uses an invalid HTTP protocol
 version or sends an invalid `Transfer-Encoding` in the request header, it will
@@ -103,19 +105,7 @@ $http->on('error', function (Exception $e) {
 });
 ```
 
-An `error` event will be emitted for the `Request` if the validation of the body data fails.
-This can be e.g. invalid chunked decoded data or an unexpected `end` event.
-
-```php
-$http->on('request', function (Request $request, Response $response) {
-    $request->on('error', function (\Exception $error) {
-        echo $error->getMessage();
-    });
-});
-```
-
-Such an error will `pause` the connection instead of closing it. A response message
-can still be sent.
+The request object can also emit an error. Checkout [Request](#request) for more details.
 
 ### Request
 
@@ -126,6 +116,34 @@ The `Transfer-Encoding` header will be removed.
 
 It implements the `ReadableStreamInterface`.
 
+Listen on the `data` event and the `end` event of the [Request](#request)
+to evaluate the data of the request body:
+
+```php
+$http->on('request', function (Request $request, Response $response) {
+    $contentLength = 0;
+    $request->on('data', function ($data) use (&$contentLength) {
+        $contentLength += strlen($data);
+    });
+
+    $request->on('end', function () use ($response, &$contentLength){
+        $response->writeHead(200, array('Content-Type' => 'text/plain'));
+        $response->end("The length of the submitted request body is: " . $contentLength);
+    });
+
+    // an error occures e.g. on invalid chunked encoded data or an unexpected 'end' event 
+    $request->on('error', function (\Exception $exception) use ($response, &$contentLength) {
+        $response->writeHead(400, array('Content-Type' => 'text/plain'));
+        $response->end("An error occured while reading at length: " . $contentLength);
+    });
+});
+```
+
+An error will just `pause` the connection instead of closing it. A response message
+can still be sent.
+
+A `close` event will be emitted after an `error` or `end` event.
+
 The constructor is internal, you SHOULD NOT call this yourself.
 The `Server` is responsible for emitting `Request` and `Response` objects.
 

examples/03-handling-body-data.php

@@ -0,0 +1,34 @@
+<?php
+
+use React\EventLoop\Factory;
+use React\Socket\Server;
+use React\Http\Request;
+use React\Http\Response;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$loop = Factory::create();
+$socket = new Server(isset($argv[1]) ? $argv[1] : '0.0.0.0:0', $loop);
+
+$server = new \React\Http\Server($socket);
+$server->on('request', function (Request $request, Response $response) {
+    $contentLength = 0;
+    $request->on('data', function ($data) use (&$contentLength) {
+        $contentLength += strlen($data);
+    });
+
+    $request->on('end', function () use ($response, &$contentLength){
+        $response->writeHead(200, array('Content-Type' => 'text/plain'));
+        $response->end("The length of the submitted request body is: " . $contentLength);
+    });
+
+    // an error occures e.g. on invalid chunked encoded data or an unexpected 'end' event
+    $request->on('error', function (\Exception $exception) use ($response, &$contentLength) {
+        $response->writeHead(400, array('Content-Type' => 'text/plain'));
+        $response->end("An error occured while reading at length: " . $contentLength);
+    });
+});
+
+echo 'Listening on http://' . $socket->getAddress() . PHP_EOL;
+
+$loop->run();