/usr/share/doc/php-guzzlehttp-ringphp/html/futures.html is in php-guzzlehttp-ringphp-doc 1.1.0-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Futures — RingPHP</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="RingPHP" href="index.html"/>
<link rel="next" title="Client Middleware" href="client_middleware.html"/>
<link rel="prev" title="Specification" href="spec.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> RingPHP
</a>
<div class="version">
1.0.0-alpha
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="spec.html">Specification</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Futures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#promises">Promises</a></li>
<li class="toctree-l2"><a class="reference internal" href="#waiting">Waiting</a></li>
<li class="toctree-l2"><a class="reference internal" href="#future-responses">Future Responses</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cancelling">Cancelling</a></li>
<li class="toctree-l2"><a class="reference internal" href="#wrapping-an-existing-promise">Wrapping an existing Promise</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="client_middleware.html">Client Middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_handlers.html">Client Handlers</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">RingPHP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Futures</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/futures.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="futures">
<h1>Futures<a class="headerlink" href="#futures" title="Permalink to this headline">¶</a></h1>
<p>Futures represent a computation that may have not yet completed. RingPHP
uses hybrid of futures and promises to provide a consistent API that can be
used for both blocking and non-blocking consumers.</p>
<div class="section" id="promises">
<h2>Promises<a class="headerlink" href="#promises" title="Permalink to this headline">¶</a></h2>
<p>You can get the result of a future when it is ready using the promise interface
of a future. Futures expose a promise API via a <code class="docutils literal"><span class="pre">then()</span></code> method that utilizes
<a class="reference external" href="https://github.com/reactphp/promise">React’s promise library</a>. You should
use this API when you do not wish to block.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\CurlMultiHandler</span><span class="p">;</span>
<span class="nv">$request</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">'http_method'</span> <span class="o">=></span> <span class="s1">'GET'</span><span class="p">,</span>
<span class="s1">'uri'</span> <span class="o">=></span> <span class="s1">'/'</span><span class="p">,</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'host'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'httpbin.org'</span><span class="p">]]</span>
<span class="p">];</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">(</span><span class="nv">$request</span><span class="p">);</span>
<span class="c1">// Use the then() method to use the promise API of the future.</span>
<span class="nv">$response</span><span class="o">-></span><span class="na">then</span><span class="p">(</span><span class="k">function</span> <span class="p">(</span><span class="nv">$response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">'status'</span><span class="p">];</span>
<span class="p">});</span>
</pre></div>
</div>
<p>You can get the promise used by a future, an instance of
<code class="docutils literal"><span class="pre">React\Promise\PromiseInterface</span></code>, by calling the <code class="docutils literal"><span class="pre">promise()</span></code> method.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">(</span><span class="nv">$request</span><span class="p">);</span>
<span class="nv">$promise</span> <span class="o">=</span> <span class="nv">$response</span><span class="o">-></span><span class="na">promise</span><span class="p">();</span>
<span class="nv">$promise</span><span class="o">-></span><span class="na">then</span><span class="p">(</span><span class="k">function</span> <span class="p">(</span><span class="nv">$response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">'status'</span><span class="p">];</span>
<span class="p">});</span>
</pre></div>
</div>
<p>This promise value can be used with React’s
<a class="reference external" href="https://github.com/reactphp/promise#functions">aggregate promise functions</a>.</p>
</div>
<div class="section" id="waiting">
<h2>Waiting<a class="headerlink" href="#waiting" title="Permalink to this headline">¶</a></h2>
<p>You can wait on a future to complete and retrieve the value, or <em>dereference</em>
the future, using the <code class="docutils literal"><span class="pre">wait()</span></code> method. Calling the <code class="docutils literal"><span class="pre">wait()</span></code> method of a
future will block until the result is available. The result is then returned or
an exception is thrown if and exception was encountered while waiting on the
the result. Subsequent calls to dereference a future will return the previously
completed result or throw the previously encountered exception. Futures can be
cancelled, which stops the computation if possible.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\CurlMultiHandler</span><span class="p">;</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">([</span>
<span class="s1">'http_method'</span> <span class="o">=></span> <span class="s1">'GET'</span><span class="p">,</span>
<span class="s1">'uri'</span> <span class="o">=></span> <span class="s1">'/'</span><span class="p">,</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'host'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'httpbin.org'</span><span class="p">]]</span>
<span class="p">]);</span>
<span class="c1">// You can explicitly call block to wait on a result.</span>
<span class="nv">$realizedResponse</span> <span class="o">=</span> <span class="nv">$response</span><span class="o">-></span><span class="na">wait</span><span class="p">();</span>
<span class="c1">// Future responses can be used like a regular PHP array.</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">'status'</span><span class="p">];</span>
</pre></div>
</div>
<p>In addition to explicitly calling the <code class="docutils literal"><span class="pre">wait()</span></code> function, using a future like
a normal value will implicitly trigger the <code class="docutils literal"><span class="pre">wait()</span></code> function.</p>
</div>
<div class="section" id="future-responses">
<h2>Future Responses<a class="headerlink" href="#future-responses" title="Permalink to this headline">¶</a></h2>
<p>RingPHP uses futures to return asynchronous responses immediately. Client
handlers always return future responses that implement
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\ArrayFutureInterface</span></code>. These future responses act
just like normal PHP associative arrays for blocking access and provide a
promise interface for non-blocking access.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\CurlMultiHandler</span><span class="p">;</span>
<span class="nv">$handler</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CurlMultiHandler</span><span class="p">();</span>
<span class="nv">$request</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">'http_method'</span> <span class="o">=></span> <span class="s1">'GET'</span><span class="p">,</span>
<span class="s1">'uri'</span> <span class="o">=></span> <span class="s1">'/'</span><span class="p">,</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'Host'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'www.google.com'</span><span class="p">]]</span>
<span class="p">];</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">(</span><span class="nv">$request</span><span class="p">);</span>
<span class="c1">// Use the promise API for non-blocking access to the response. The actual</span>
<span class="c1">// response value will be delivered to the promise.</span>
<span class="nv">$response</span><span class="o">-></span><span class="na">then</span><span class="p">(</span><span class="k">function</span> <span class="p">(</span><span class="nv">$response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">'status'</span><span class="p">];</span>
<span class="p">});</span>
<span class="c1">// You can wait (block) until the future is completed.</span>
<span class="nv">$response</span><span class="o">-></span><span class="na">wait</span><span class="p">();</span>
<span class="c1">// This will implicitly call wait(), and will block too!</span>
<span class="nv">$response</span><span class="p">[</span><span class="s1">'status'</span><span class="p">];</span>
</pre></div>
</div>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">Futures that are not completed by the time the underlying handler is
destructed will be completed when the handler is shutting down.</p>
</div>
</div>
<div class="section" id="cancelling">
<h2>Cancelling<a class="headerlink" href="#cancelling" title="Permalink to this headline">¶</a></h2>
<p>Futures can be cancelled if they have not already been dereferenced.</p>
<p>RingPHP futures are typically implemented with the
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\BaseFutureTrait</span></code>. This trait provides the cancellation
functionality that should be common to most implementations. Cancelling a
future response will try to prevent the request from sending over the wire.</p>
<p>When a future is cancelled, the cancellation function is invoked and performs
the actual work needed to cancel the request from sending if possible
(e.g., telling an event loop to stop sending a request or to close a socket).
If no cancellation function is provided, then a request cannot be cancelled. If
a cancel function is provided, then it should accept the future as an argument
and return true if the future was successfully cancelled or false if it could
not be cancelled.</p>
</div>
<div class="section" id="wrapping-an-existing-promise">
<h2>Wrapping an existing Promise<a class="headerlink" href="#wrapping-an-existing-promise" title="Permalink to this headline">¶</a></h2>
<p>You can easily create a future from any existing promise using the
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureValue</span></code> class. This class’s constructor
accepts a promise as the first argument, a wait function as the second
argument, and a cancellation function as the third argument. The dereference
function is used to force the promise to resolve (for example, manually ticking
an event loop). The cancel function is optional and is used to tell the thing
that created the promise that it can stop computing the result (for example,
telling an event loop to stop transferring a request).</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Future\FutureValue</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">React\Promise\Deferred</span><span class="p">;</span>
<span class="nv">$deferred</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Deferred</span><span class="p">();</span>
<span class="nv">$promise</span> <span class="o">=</span> <span class="nv">$deferred</span><span class="o">-></span><span class="na">promise</span><span class="p">();</span>
<span class="nv">$f</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">FutureValue</span><span class="p">(</span>
<span class="nv">$promise</span><span class="p">,</span>
<span class="k">function</span> <span class="p">()</span> <span class="k">use</span> <span class="p">(</span><span class="nv">$deferred</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// This function is responsible for blocking and resolving the</span>
<span class="c1">// promise. Here we pass in a reference to the deferred so that</span>
<span class="c1">// it can be resolved or rejected.</span>
<span class="nv">$deferred</span><span class="o">-></span><span class="na">resolve</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">);</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="client_middleware.html" class="btn btn-neutral float-right" title="Client Middleware" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="spec.html" class="btn btn-neutral" title="Specification" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, Michael Dowling.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|