docs/class-GuzzleHttp.Handler.CurlMultiHandler.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class GuzzleHttp\Handler\CurlMultiHandler | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li>
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li class="active">
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li class="active">
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li>
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-GuzzleHttp.Handler.CurlFactory.html">CurlFactory</a></li>
<li><a href="class-GuzzleHttp.Handler.CurlHandler.html">CurlHandler</a></li>
<li class="active"><a href="class-GuzzleHttp.Handler.CurlMultiHandler.html">CurlMultiHandler</a></li>
<li><a href="class-GuzzleHttp.Handler.MockHandler.html">MockHandler</a></li>
<li><a href="class-GuzzleHttp.Handler.Proxy.html">Proxy</a></li>
<li><a href="class-GuzzleHttp.Handler.StreamHandler.html">StreamHandler</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-GuzzleHttp.Handler.CurlFactoryInterface.html">CurlFactoryInterface</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html" title="Summary of GuzzleHttp\Handler"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class CurlMultiHandler</h1>
<div class="description">
<p>Returns an asynchronous response using curl_multi_* functions.</p>
<p>When using the CurlMultiHandler, custom curl options can be specified as an
associative array of curl option constants mapping to values in the
<strong>curl</strong> key of the provided request options.</p>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-GuzzleHttp.html">GuzzleHttp</a>\<a href="namespace-GuzzleHttp.Handler.html">Handler</a><br>
<b>Located at</b> <a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#9-197" title="Go to source code">Handler/CurlMultiHandler.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#27-42" title="Go to source code">__construct</a>( <span>array <var>$options</var> = []</span> )</code>
<div class="description short">
<p>This handler accepts the following options:</p>
</div>
<div class="description detailed hidden">
<p>This handler accepts the following options:</p>
<ul>
<li>handle_factory: An optional factory used to create curl handles</li>
<li>select_timeout: Optional timeout (in seconds) to block before timing out while selecting curl handles. Defaults to 1 second.</li>
</ul>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$options</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="__get" id="___get">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___get">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#44-51" title="Go to source code">__get</a>( <span> <var>$name</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="__destruct" id="___destruct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___destruct">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#53-59" title="Go to source code">__destruct</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="__invoke" id="___invoke">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___invoke">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#61-74" title="Go to source code">__invoke</a>( <span><code><a href="class-Psr.Http.Message.RequestInterface.html">Psr\Http\Message\RequestInterface</a></code> <var>$request</var></span>, <span>array <var>$options</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="tick" id="_tick">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_tick">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#76-109" title="Go to source code">tick</a>( )</code>
<div class="description short">
<p>Ticks the curl event loop.</p>
</div>
<div class="description detailed hidden">
<p>Ticks the curl event loop.</p>
</div>
</div></td>
</tr>
<tr data-order="execute" id="_execute">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_execute">#</a>
<code><a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#111-125" title="Go to source code">execute</a>( )</code>
<div class="description short">
<p>Runs until all outstanding connections have completed.</p>
</div>
<div class="description detailed hidden">
<p>Runs until all outstanding connections have completed.</p>
</div>
</div></td>
</tr>
</table>
<table class="summary properties" id="magicProperties">
<caption>Magic properties summary</caption>
<tr data-order="_mh" id="m$_mh">
<td class="attributes"><code>
public
resource
</code></td>
<td class="name">
<a href="source-class-GuzzleHttp.Handler.CurlMultiHandler.html#16" title="Go to source code"><var>$_mh</var></a>
<div class="description short">
<p>Internal use only. Lazy loaded multi-handle.</p>
</div>
<div class="description detailed hidden">
</div>
</td>
</tr>
</table>
</div>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>