<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Send data to all job servers to see if they echo it back</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.jobstatus.html">GearmanClient::jobStatus</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanclient.removeoptions.html">GearmanClient::removeOptions</a></div>
<div class="up"><a href="class.gearmanclient.html">GearmanClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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 SVN)</p><p class="refpurpose"><span class="refname">GearmanClient::ping</span> — <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="type">bool</span> <span class="methodname"><strong>GearmanClient::ping</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$workload</code></span>
)</div>
<p class="para rdfs-comment">
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>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">workload</code></em></span>
<dd>
<p class="para">
Some arbitrary serialized data to be echo back
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-gearmanclient.ping-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.jobstatus.html">GearmanClient::jobStatus</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanclient.removeoptions.html">GearmanClient::removeOptions</a></div>
<div class="up"><a href="class.gearmanclient.html">GearmanClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
