<?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 => 'en',
  ),
  'this' => 
  array (
    0 => 'gearmanclient.ping.php',
    1 => 'GearmanClient::ping',
    2 => 'Send data to all job servers to see if they echo it back',
  ),
  'up' => 
  array (
    0 => 'class.gearmanclient.php',
    1 => 'GearmanClient',
  ),
  'prev' => 
  array (
    0 => 'gearmanclient.jobstatus.php',
    1 => 'GearmanClient::jobStatus',
  ),
  'next' => 
  array (
    0 => 'gearmanclient.removeoptions.php',
    1 => 'GearmanClient::removeOptions',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/gearman/gearmanclient/ping.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="gearmanclient.ping" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">GearmanClient::ping</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">GearmanClient::ping</span> &mdash; <span class="dc-title">Send data to all job servers to see if they echo it back</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-gearmanclient.ping-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>GearmanClient::ping</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$workload</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Sends some arbitrary data to all job servers to see if they echo it back.  The data sent
   is not used or processed in any other way.  Primarily used for testing and debugging.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-gearmanclient.ping-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">workload</code></dt>
    <dd>
     <span class="simpara">
      Some arbitrary serialized data to be echo back
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-gearmanclient.ping-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><?php manual_footer($setup); ?>