<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yar-concurrent-client.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yar-concurrent-client.loop.php',
    1 => 'Yar_Concurrent_Client::loop',
    2 => '发送并等待所有已注册的调用',
  ),
  'up' => 
  array (
    0 => 'class.yar-concurrent-client.php',
    1 => 'Yar_Concurrent_Client',
  ),
  'prev' => 
  array (
    0 => 'yar-concurrent-client.call.php',
    1 => 'Yar_Concurrent_Client::call',
  ),
  'next' => 
  array (
    0 => 'yar-concurrent-client.reset.php',
    1 => 'Yar_Concurrent_Client::reset',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yar/yar_concurrent_client/loop.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yar-concurrent-client.loop" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yar_Concurrent_Client::loop</h1>
  <p class="verinfo">(PECL yar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Yar_Concurrent_Client::loop</span> &mdash; <span class="dc-title">发送并等待所有已注册的调用</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yar-concurrent-client.loop-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">static</span> <span class="modifier">function</span> <span class="methodname"><strong>Yar_Concurrent_Client::loop</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span></span> <code class="parameter">$callback</code><span class="initializer"> = null</span></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span></span> <code class="parameter">$error_callback</code><span class="initializer"> = null</span></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$options</code><span class="initializer"> = null</span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>

  <p class="simpara">
   并行发送所有通过
   <span class="methodname"><a href="yar-concurrent-client.call.php" class="methodname">Yar_Concurrent_Client::call()</a></span> 注册的调用，
   并阻塞直到每一个响应都已到达并被处理完毕。
   此方法返回时，调用列表会被清空。
  </p>
  <p class="simpara">
   由于这些调用是同时执行的，loop 的耗时只等于最慢单次调用的耗时，
   而不是所有调用耗时之和。但回调不会按照调用注册的顺序触发：
   哪个响应先到达，就先触发哪个回调。要确定某个响应属于哪次调用，
   可以将 <code class="literal">callinfo</code> 参数中的
   <code class="literal">sequence</code> 与
   <span class="methodname"><a href="yar-concurrent-client.call.php" class="methodname">Yar_Concurrent_Client::call()</a></span>
   返回的序列号进行对照。<code class="literal">callinfo</code> <span class="type"><a href="language.types.array.php" class="type array">array</a></span>
   包含该调用的 <code class="literal">sequence</code>、<code class="literal">uri</code> 和
   <code class="literal">method</code>；参见
   <span class="methodname"><a href="yar-concurrent-client.call.php" class="methodname">Yar_Concurrent_Client::call()</a></span>。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yar-concurrent-client.loop-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">callback</code></dt>
    <dd>
     <p class="simpara">
      <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span>，用于处理未指定自身回调的调用的响应。
      在全部请求发送完毕后、任何响应到达之前，它还会额外被调用一次，
      此时两个参数均为 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
     </p>
     <p class="simpara">
      如果省略该参数，成功调用的返回值会在其响应到达时被直接打印输出。
     </p>
    </dd>
   
   
    <dt><code class="parameter">error_callback</code></dt>
    <dd>
     <p class="simpara">
      <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span>，用于处理未指定自身错误回调的调用的错误。
      接收三个参数：错误类型（<code class="literal">YAR_ERR_*</code>
      错误码之一）、错误消息，以及 <code class="literal">callinfo</code> <span class="type"><a href="language.types.array.php" class="type array">array</a></span>。
     </p>
     <p class="simpara">
      如果省略该参数，失败的调用会改为触发一条 PHP 警告；
      这一点与同步的 <span class="classname"><a href="class.yar-client.php" class="classname">Yar_Client</a></span> 不同，
      后者会抛出异常。
     </p>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="simpara">
      客户端选项的 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>，以
      <code class="literal">YAR_OPT_*</code> 常量作为键，
      应用于每一个未自行覆盖这些选项的已注册调用。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yar-concurrent-client.loop-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   当所有已注册的调用都已处理完毕，或者根本没有注册任何调用时，返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>。
   如果并发客户端已经在另一个 loop 中运行，则返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>；
   此时会产生一条警告。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yar-concurrent-client.loop-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yar_Concurrent_Client::loop()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #007700">function </span><span style="color: #0000BB">callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">, </span><span style="color: #0000BB">$callinfo</span><span style="color: #007700">) {
    if (</span><span style="color: #0000BB">$callinfo </span><span style="color: #007700">== </span><span style="color: #0000BB">NULL</span><span style="color: #007700">) {
        echo </span><span style="color: #DD0000">"Now, all requests are sent, and no response available\n"</span><span style="color: #007700">;
    } else {
        echo </span><span style="color: #DD0000">"This is a remote call response, the method name is "</span><span style="color: #007700">, </span><span style="color: #0000BB">$callinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">"method"</span><span style="color: #007700">],
             </span><span style="color: #DD0000">". calling sequence is "</span><span style="color: #007700">, </span><span style="color: #0000BB">$callinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">"sequence"</span><span style="color: #007700">], </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;
        </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);
    }
}

function </span><span style="color: #0000BB">error_callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$type</span><span style="color: #007700">, </span><span style="color: #0000BB">$error</span><span style="color: #007700">, </span><span style="color: #0000BB">$callinfo</span><span style="color: #007700">) {
    </span><span style="color: #0000BB">error_log</span><span style="color: #007700">(</span><span style="color: #0000BB">$error</span><span style="color: #007700">);
}

</span><span style="color: #0000BB">Yar_Concurrent_Client</span><span style="color: #007700">::</span><span style="color: #0000BB">call</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://api.example.com/operator.php"</span><span style="color: #007700">, </span><span style="color: #DD0000">"some_method"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"parameters"</span><span style="color: #007700">), </span><span style="color: #DD0000">"callback"</span><span style="color: #007700">);

</span><span style="color: #FF8000">/* 如果不指定回调，将使用 loop() 的回调 */
</span><span style="color: #0000BB">Yar_Concurrent_Client</span><span style="color: #007700">::</span><span style="color: #0000BB">call</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://api.example.com/operator.php"</span><span style="color: #007700">, </span><span style="color: #DD0000">"some_method"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"parameters"</span><span style="color: #007700">));

</span><span style="color: #0000BB">Yar_Concurrent_Client</span><span style="color: #007700">::</span><span style="color: #0000BB">loop</span><span style="color: #007700">(</span><span style="color: #DD0000">"callback"</span><span style="color: #007700">, </span><span style="color: #DD0000">"error_callback"</span><span style="color: #007700">);
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>以上示例的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Now, all requests are sent, and no response available
This is a remote call response, the method name is some_method. calling sequence is 2
string(11) &quot;some_method&quot;
This is a remote call response, the method name is some_method. calling sequence is 1
string(11) &quot;some_method&quot;</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yar-concurrent-client.loop-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yar-concurrent-client.call.php" class="methodname" rel="rdfs-seeAlso">Yar_Concurrent_Client::call()</a> - 注册一个并发调用</span></li>
   <li><span class="methodname"><a href="yar-concurrent-client.reset.php" class="methodname" rel="rdfs-seeAlso">Yar_Concurrent_Client::reset()</a> - 清除所有已注册的调用</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>