Skip to content

Create the React adapter documentation #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions clients/react-adapter.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,81 @@
React Adapter
=============

An HTTPlug adapter for the `React Http client`_.

Installation
------------

Use Composer_ to install the React adapter. It will also install React as it's a
dependency.

.. code-block:: bash

$ composer require php-http/react-adapter

.. include:: includes/install-message-factory.inc

.. include:: includes/install-discovery.inc

Usage
-----

The React client adapter needs a :ref:`message factory <message-factory>` in
order to to work::

use Http\Adapter\React\Client;

$client = new Client($messageFactory);

For simplicity, all required objects are instantiated automatically if not
explicitly specified:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all required objects

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about this one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also fixed it !


:React\EventLoop\LoopInterface: The event loop used inside the React engine.
:React\HttpClient\Client: The HTTP client instance that must be adapted.

If you need more control on the React instances, you can inject them during
initialization::

use Http\Adapter\React\Client;

$eventLoop = React\EventLoop\Factory::create();
$dnsResolverFactory = new React\Dns\Resolver\Factory();
$dnsResolver = $dnsResolverFactory->createCached('8.8.8.8', $loop);

$factory = new React\HttpClient\Factory();
$reactHttp = $factory->create($loop, $dnsResolver);

$adapter = new Client($messageFactory, $eventLoop, $reactHttp);

If you choose to inject a custom React HTTP client, you must inject the loop
used during its construction. But if you already use an EventLoop inside your
code, you can inject only this object.

You can also use a ``ReactFactory`` in order to initialize React instances::

use Http\Adapter\React\ReactFactory;

$eventLoop = ReactFactory::buildEventLoop();
$reactHttp = ReactFactory::buildHttpClient($eventLoop);

Then you can use the adapter to send synchronous requests::

use GuzzleHttp\Psr7\Request;

$request = new Request('GET', 'http://httpbin.org');

// Returns a Psr\Http\Message\ResponseInterface
$response = $adapter->sendRequest($request);

Or send asynchronous ones::

use GuzzleHttp\Psr7\Request;

$request = new Request('GET', 'http://httpbin.org');

// Returns a Http\Promise\Promise
$promise = $adapter->sendAsyncRequest(request);

.. include:: includes/further-reading-async.inc

.. _React HTTP client: https://github.com/reactphp/http-client