<!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 status</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="gearmanjob.sendfail.html">GearmanJob::sendFail</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanjob.sendwarning.html">GearmanJob::sendWarning</a></div> <div class="up"><a href="class.gearmanjob.html">GearmanJob</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="gearmanjob.sendstatus" class="refentry"> <div class="refnamediv"> <h1 class="refname">GearmanJob::sendStatus</h1> <p class="verinfo">(PECL gearman >= 0.6.0)</p><p class="refpurpose"><span class="refname">GearmanJob::sendStatus</span> — <span class="dc-title">Send status</span></p> </div> <div class="refsect1 description" id="refsect1-gearmanjob.sendstatus-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>GearmanJob::sendStatus</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$numerator</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$denominator</code></span> )</div> <p class="para rdfs-comment"> Sends status information to the job server and any listening clients. Use this to specify what percentage of the job has been completed. </p> </div> <div class="refsect1 parameters" id="refsect1-gearmanjob.sendstatus-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">numerator</code></em></span> <dd> <p class="para"> The numerator of the precentage completed expressed as a fraction. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">denominator</code></em></span> <dd> <p class="para"> The denominator of the precentage completed expressed as a fraction. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-gearmanjob.sendstatus-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 class="refsect1 seealso" id="refsect1-gearmanjob.sendstatus-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="gearmanclient.jobstatus.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::jobStatus()</a> - Get the status of a background job</span></li> <li class="member"> <span class="methodname"><a href="gearmantask.taskdenominator.html" class="methodname" rel="rdfs-seeAlso">GearmanTask::taskDenominator()</a> - Get completion percentage denominator</span></li> <li class="member"> <span class="methodname"><a href="gearmantask.tasknumerator.html" class="methodname" rel="rdfs-seeAlso">GearmanTask::taskNumerator()</a> - Get completion percentage numerator</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="gearmanjob.sendfail.html">GearmanJob::sendFail</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanjob.sendwarning.html">GearmanJob::sendWarning</a></div> <div class="up"><a href="class.gearmanjob.html">GearmanJob</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>