php-guzzlehttp-ringphp-doc 1.1.0-2ubuntu1 / usr / share / doc / php-guzzlehttp-ringphp / html / client_handlers.html

This file is indexed.

/usr/share/doc/php-guzzlehttp-ringphp/html/client_handlers.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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<!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>Client Handlers &mdash; 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="Testing" href="testing.html"/>
        <link rel="prev" title="Client Middleware" href="client_middleware.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"><a class="reference internal" href="futures.html">Futures</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_middleware.html">Client Middleware</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Client Handlers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#built-in-handlers">Built-In Handlers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#stream-handler">Stream Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="#curl-handler">cURL Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="#curl-multi-handler">cURL Multi Handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mock-handler">Mock Handler</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#implementing-handlers">Implementing Handlers</a></li>
</ul>
</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> &raquo;</li>
      
    <li>Client Handlers</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/client_handlers.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="client-handlers">
<h1>Client Handlers<a class="headerlink" href="#client-handlers" title="Permalink to this headline"></a></h1>
<p>Client handlers accept a request array and return a future response array that
can be used synchronously as an array or asynchronously using a promise.</p>
<div class="section" id="built-in-handlers">
<h2>Built-In Handlers<a class="headerlink" href="#built-in-handlers" title="Permalink to this headline"></a></h2>
<p>RingPHP comes with three built-in client handlers.</p>
<div class="section" id="stream-handler">
<h3>Stream Handler<a class="headerlink" href="#stream-handler" title="Permalink to this headline"></a></h3>
<p>The <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Client\StreamHandler</span></code> uses PHP&#8217;s
<a class="reference external" href="http://php.net/manual/en/wrappers.http.php">http stream wrapper</a> to send
requests.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This handler cannot send requests concurrently.</p>
</div>
<p>You can provide an associative array of custom stream context options to the
StreamHandler using the <code class="docutils literal"><span class="pre">stream_context</span></code> key of the <code class="docutils literal"><span class="pre">client</span></code> request
option.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\StreamHandler</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">&#39;http_method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span>
    <span class="s1">&#39;uri&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;/&#39;</span><span class="p">,</span>
    <span class="s1">&#39;headers&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;httpbin.org&#39;</span><span class="p">]],</span>
    <span class="s1">&#39;client&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
        <span class="s1">&#39;stream_context&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
            <span class="s1">&#39;http&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
                <span class="s1">&#39;request_fulluri&#39;</span> <span class="o">=&gt;</span> <span class="k">true</span><span class="p">,</span>
                <span class="s1">&#39;method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;HEAD&#39;</span>
            <span class="p">],</span>
            <span class="s1">&#39;socket&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
                <span class="s1">&#39;bindto&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;127.0.0.1:0&#39;</span>
            <span class="p">],</span>
            <span class="s1">&#39;ssl&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
                <span class="s1">&#39;verify_peer&#39;</span> <span class="o">=&gt;</span> <span class="k">false</span>
            <span class="p">]</span>
        <span class="p">]</span>
    <span class="p">]</span>
<span class="p">]);</span>

<span class="c1">// Even though it&#39;s already completed, you can still use a promise</span>
<span class="nv">$response</span><span class="o">-&gt;</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">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>
<span class="p">});</span>

<span class="c1">// Or access the response using the future interface</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>
</pre></div>
</div>
</div>
<div class="section" id="curl-handler">
<h3>cURL Handler<a class="headerlink" href="#curl-handler" title="Permalink to this headline"></a></h3>
<p>The <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Client\CurlHandler</span></code> can be used with PHP 5.5+ to send
requests using cURL easy handles. This handler is great for sending requests
one at a time because the execute and select loop is implemented in C code
which executes faster and consumes less memory than using PHP&#8217;s
<code class="docutils literal"><span class="pre">curl_multi_*</span></code> interface.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This handler cannot send requests concurrently.</p>
</div>
<p>When using the CurlHandler, custom curl options can be specified as an
associative array of <a class="reference external" href="http://php.net/manual/en/curl.constants.php">cURL option constants</a>
mapping to values in the <code class="docutils literal"><span class="pre">client</span></code> option of a requst using the <strong>curl</strong> key.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\CurlHandler</span><span class="p">;</span>

<span class="nv">$handler</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CurlHandler</span><span class="p">();</span>

<span class="nv">$request</span> <span class="o">=</span> <span class="p">[</span>
    <span class="s1">&#39;http_method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span>
    <span class="s1">&#39;headers&#39;</span>     <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nx">Server</span><span class="o">::</span><span class="nv">$host</span><span class="p">]],</span>
    <span class="s1">&#39;client&#39;</span>      <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;curl&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nx">CURLOPT_LOW_SPEED_LIMIT</span> <span class="o">=&gt;</span> <span class="mi">10</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">// The response can be used directly as an array.</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>

<span class="c1">// Or, it can be used as a promise (that has already fulfilled).</span>
<span class="nv">$response</span><span class="o">-&gt;</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">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>
<span class="p">});</span>
</pre></div>
</div>
</div>
<div class="section" id="curl-multi-handler">
<h3>cURL Multi Handler<a class="headerlink" href="#curl-multi-handler" title="Permalink to this headline"></a></h3>
<p>The <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Client\CurlMultiHandler</span></code> transfers requests using
cURL&#8217;s <a class="reference external" href="http://curl.haxx.se/libcurl/c/libcurl-multi.html">multi API</a>. The
<code class="docutils literal"><span class="pre">CurlMultiHandler</span></code> is great for sending requests concurrently.</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">&#39;http_method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span>
    <span class="s1">&#39;headers&#39;</span>     <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nx">Server</span><span class="o">::</span><span class="nv">$host</span><span class="p">]]</span>
<span class="p">];</span>

<span class="c1">// this call returns a future array immediately.</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">// Ideally, you should use the promise API to not block.</span>
<span class="nv">$response</span>
    <span class="o">-&gt;</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="c1">// Got the response at some point in the future</span>
        <span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>
        <span class="c1">// Don&#39;t break the chain</span>
        <span class="k">return</span> <span class="nv">$response</span><span class="p">;</span>
    <span class="p">})</span><span class="o">-&gt;</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="c1">// ...</span>
    <span class="p">});</span>

<span class="c1">// If you really need to block, then you can use the response as an</span>
<span class="c1">// associative array. This will block until it has completed.</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">];</span> <span class="c1">// 200</span>
</pre></div>
</div>
<p>Just like the <code class="docutils literal"><span class="pre">CurlHandler</span></code>, the <code class="docutils literal"><span class="pre">CurlMultiHandler</span></code> accepts custom curl
option in the <code class="docutils literal"><span class="pre">curl</span></code> key of the <code class="docutils literal"><span class="pre">client</span></code> request option.</p>
</div>
<div class="section" id="mock-handler">
<h3>Mock Handler<a class="headerlink" href="#mock-handler" title="Permalink to this headline"></a></h3>
<p>The <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Client\MockHandler</span></code> is used to return mock responses.
When constructed, the handler can be configured to return the same response
array over and over, a future response, or a the evaluation of a callback
function.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\MockHandler</span><span class="p">;</span>

<span class="c1">// Return a canned response.</span>
<span class="nv">$mock</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">MockHandler</span><span class="p">([</span><span class="s1">&#39;status&#39;</span> <span class="o">=&gt;</span> <span class="mi">200</span><span class="p">]);</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$mock</span><span class="p">([]);</span>
<span class="nb">assert</span><span class="p">(</span><span class="mi">200</span> <span class="o">==</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]);</span>
<span class="nb">assert</span><span class="p">([]</span> <span class="o">==</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]);</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="implementing-handlers">
<h2>Implementing Handlers<a class="headerlink" href="#implementing-handlers" title="Permalink to this headline"></a></h2>
<p>Client handlers are just PHP callables (functions or classes that have the
<code class="docutils literal"><span class="pre">__invoke</span></code> magic method). The callable accepts a request array and MUST
return an instance of <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureArrayInterface</span></code> so that
the response can be used by both blocking and non-blocking consumers.</p>
<p>Handlers need to follow a few simple rules:</p>
<ol class="arabic simple">
<li>Do not throw exceptions. If an error is encountered, return an array that
contains the <code class="docutils literal"><span class="pre">error</span></code> key that maps to an <code class="docutils literal"><span class="pre">\Exception</span></code> value.</li>
<li>If the request has a <code class="docutils literal"><span class="pre">delay</span></code> client option, then the handler should only
send the request after the specified delay time in seconds. Blocking
handlers may find it convenient to just let the
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Core::doSleep($request)</span></code> function handle this for them.</li>
<li>Always return an instance of <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureArrayInterface</span></code>.</li>
<li>Complete any outstanding requests when the handler is destructed.</li>
</ol>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="testing.html" class="btn btn-neutral float-right" title="Testing" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="client_middleware.html" class="btn btn-neutral" title="Client Middleware" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; 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>

APT Browse - Built by Thomas Orozco.