<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.gearmanworker.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'gearmanworker.wait.php',
    1 => 'GearmanWorker::wait',
    2 => 'Wait for activity from one of the job servers',
  ),
  'up' => 
  array (
    0 => 'class.gearmanworker.php',
    1 => 'GearmanWorker',
  ),
  'prev' => 
  array (
    0 => 'gearmanworker.unregisterall.php',
    1 => 'GearmanWorker::unregisterAll',
  ),
  'next' => 
  array (
    0 => 'gearmanworker.work.php',
    1 => 'GearmanWorker::work',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/gearman/gearmanworker/wait.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="gearmanworker.wait" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">GearmanWorker::wait</h1>
  <p class="verinfo">(PECL gearman &gt;= 0.6.0)</p><p class="refpurpose"><span class="refname">GearmanWorker::wait</span> &mdash; <span class="dc-title">Wait for activity from one of the job servers</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-gearmanworker.wait-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>GearmanWorker::wait</strong></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Causes the worker to wait for activity from one of the Gearman job servers when operating
   in non-blocking I/O mode.  On failure, issues a <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> with the last Gearman error
   encountered.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-gearmanworker.wait-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">This function has no parameters.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-gearmanworker.wait-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-gearmanworker.wait-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 Running worker in non-blocking mode</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Starting\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000"># Create our worker object<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanWorker</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Make the worker non-blocking<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addOptions</span><span style="color: #007700">(</span><span style="color: #0000BB">GEARMAN_WORKER_NON_BLOCKING</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000"># Add the default server (localhost, port 4730)<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Add our reverse function<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFunction</span><span style="color: #007700">(</span><span style="color: #DD0000">'reverse'</span><span style="color: #007700">, </span><span style="color: #DD0000">'reverse_fn'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000"># Try to grab a job<br /></span><span style="color: #007700">while (@</span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">work</span><span style="color: #007700">() ||<br />       </span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">GEARMAN_IO_WAIT </span><span style="color: #007700">||<br />       </span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">GEARMAN_NO_JOBS</span><span style="color: #007700">)<br />{<br />  if (</span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">GEARMAN_SUCCESS</span><span style="color: #007700">)<br />    continue;<br /><br />  echo </span><span style="color: #DD0000">"Waiting for next job...\n"</span><span style="color: #007700">;<br />  if (!@</span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">wait</span><span style="color: #007700">())<br />  {<br />    if (</span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">GEARMAN_NO_ACTIVE_FDS</span><span style="color: #007700">)<br />    {<br />      </span><span style="color: #FF8000"># We are not connected to any servers, so wait a bit before<br />      # trying to reconnect.<br />      </span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">);<br />      continue;<br />    }<br />    break;<br />  }<br />}<br /><br />echo </span><span style="color: #DD0000">"Worker Error: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$worker</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />function </span><span style="color: #0000BB">reverse_fn</span><span style="color: #007700">(</span><span style="color: #0000BB">$job</span><span style="color: #007700">)<br />{<br />  return </span><span style="color: #0000BB">strrev</span><span style="color: #007700">(</span><span style="color: #0000BB">$job</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">workload</span><span style="color: #007700">());<br />}<br /><br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-gearmanworker.wait-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="gearmanworker.work.php" class="methodname" rel="rdfs-seeAlso">GearmanWorker::work()</a> - Wait for and perform jobs</span></li>
  </ul>
 </div>


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