<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.gearmanclient.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'gearmanclient.addtaskstatus.php',
    1 => 'GearmanClient::addTaskStatus',
    2 => 'Add a task to get status',
  ),
  'up' => 
  array (
    0 => 'class.gearmanclient.php',
    1 => 'GearmanClient',
  ),
  'prev' => 
  array (
    0 => 'gearmanclient.addtasklowbackground.php',
    1 => 'GearmanClient::addTaskLowBackground',
  ),
  'next' => 
  array (
    0 => 'gearmanclient.clearcallbacks.php',
    1 => 'GearmanClient::clearCallbacks',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/gearman/gearmanclient/addtaskstatus.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="gearmanclient.addtaskstatus" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">GearmanClient::addTaskStatus</h1>
  <p class="verinfo">(PECL gearman &gt;= 0.5.0)</p><p class="refpurpose"><span class="refname">GearmanClient::addTaskStatus</span> &mdash; <span class="dc-title">Add a task to get status</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-gearmanclient.addtaskstatus-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>GearmanClient::addTaskStatus</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$job_handle</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$context</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="class.gearmantask.php" class="type GearmanTask">GearmanTask</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Used to request status information from the Gearman server, which will call the specified
   status callback (set using <span class="methodname"><a href="gearmanclient.setstatuscallback.php" class="methodname">GearmanClient::setStatusCallback()</a></span>).
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-gearmanclient.addtaskstatus-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">job_handle</code></dt>
    <dd>
     <span class="simpara">
      The job handle for the task to get status for
     </span>
    </dd>
   
   
    <dt><code class="parameter">context</code></dt>
    <dd>
     <span class="simpara">
      Data to be passed to the status callback, generally a reference to an array or object
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-gearmanclient.addtaskstatus-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   A <span class="classname"><a href="class.gearmantask.php" class="classname">GearmanTask</a></span> object or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-gearmanclient.addtaskstatus-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 Monitor completion of multiple background tasks</strong></p>
   <div class="example-contents"><p>
    An artificial delay is introduced in the worker in this example to simulate
    a long running process. There is only one worker running for this example.
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">/* create our object */<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanClient</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* add the default server */<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* start some background jobs and save the handles */<br /></span><span style="color: #0000BB">$handles </span><span style="color: #007700">= array();<br /></span><span style="color: #0000BB">$handles</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">] = </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">doBackground</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Hello World!"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$handles</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] = </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">doBackground</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse"</span><span style="color: #007700">, </span><span style="color: #DD0000">"!dlroW olleH"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setStatusCallback</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse_status"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Poll the server to see when those background jobs finish; */<br />/* a better method would be to use event callbacks */<br /></span><span style="color: #007700">do<br />{<br />   </span><span style="color: #FF8000">/* Use the context variable to track how many tasks have completed */<br />   </span><span style="color: #0000BB">$done </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br />   </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addTaskStatus</span><span style="color: #007700">(</span><span style="color: #0000BB">$handles</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">], </span><span style="color: #0000BB">$done</span><span style="color: #007700">);<br />   </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addTaskStatus</span><span style="color: #007700">(</span><span style="color: #0000BB">$handles</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">], </span><span style="color: #0000BB">$done</span><span style="color: #007700">);<br />   </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">runTasks</span><span style="color: #007700">();<br />   echo </span><span style="color: #DD0000">"Done: </span><span style="color: #0000BB">$done</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />   </span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br />while (</span><span style="color: #0000BB">$done </span><span style="color: #007700">!= </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /><br />function </span><span style="color: #0000BB">reverse_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$task</span><span style="color: #007700">, </span><span style="color: #0000BB">$done</span><span style="color: #007700">)<br />{<br />   if (!</span><span style="color: #0000BB">$task</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isKnown</span><span style="color: #007700">())<br />      </span><span style="color: #0000BB">$done</span><span style="color: #007700">++;<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>以上示例的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 0
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 1
Done: 2</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-gearmanclient.addtaskstatus-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="gearmanclient.setstatuscallback.php" class="methodname" rel="rdfs-seeAlso">GearmanClient::setStatusCallback()</a> - Set a callback for collecting task status</span></li>
  </ul>
 </div>


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