<!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>Callback function when there is a data packet for a task</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.setdata.html">GearmanClient::setData</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.setexceptioncallback.html">GearmanClient::setExceptionCallback</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.setdatacallback" class="refentry"> <div class="refnamediv"> <h1 class="refname">GearmanClient::setDataCallback</h1> <p class="verinfo">(PECL gearman >= 0.6.0)</p><p class="refpurpose"><span class="refname">GearmanClient::setDataCallback</span> — <span class="dc-title">Callback function when there is a data packet for a task</span></p> </div> <div class="refsect1 description" id="refsect1-gearmanclient.setdatacallback-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::setDataCallback</strong></span> ( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span> )</div> <p class="para rdfs-comment"> Sets the callback function for accepting data packets for a task. The callback function should take a single argument, a <a href="class.gearmantask.html" class="classname">GearmanTask</a> object. </p> </div> <div class="refsect1 parameters" id="refsect1-gearmanclient.setdatacallback-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">callback</code></em></span> <dd> <p class="para"> A function or method to call </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-gearmanclient.setdatacallback-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-gearmanclient.setdatacallback-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="gearmanclient.setcompletecallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setCompleteCallback()</a> - Set a function to be called on task completion</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setcreatedcallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setCreatedCallback()</a> - Set a callback for when a task is queued</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setexceptioncallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setExceptionCallback()</a> - Set a callback for worker exceptions</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setfailcallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setFailCallback()</a> - Set callback for job failure</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setstatuscallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setStatusCallback()</a> - Set a callback for collecting task status</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setwarningcallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setWarningCallback()</a> - Set a callback for worker warnings</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.setworkloadcallback.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::setWorkloadCallback()</a> - Set a callback for accepting incremental data updates</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="gearmanclient.setdata.html">GearmanClient::setData</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.setexceptioncallback.html">GearmanClient::setExceptionCallback</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>