<!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>Run a single task and return a result</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.dolowbackground.html">GearmanClient::doLowBackground</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.dostatus.html">GearmanClient::doStatus</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.donormal" class="refentry"> <div class="refnamediv"> <h1 class="refname">GearmanClient::doNormal</h1> <p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">GearmanClient::doNormal</span> — <span class="dc-title">Run a single task and return a result</span></p> </div> <div class="refsect1 description" id="refsect1-gearmanclient.donormal-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>GearmanClient::doNormal</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$function_name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$workload</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$unique</code></span> ] )</div> <p class="para rdfs-comment"> Runs a single task and returns a string representation of the result. It is up to the <a href="class.gearmanclient.html" class="classname">GearmanClient</a> and <a href="class.gearmanworker.html" class="classname">GearmanWorker</a> to agree on the format of the result. </p> </div> <div class="refsect1 parameters" id="refsect1-gearmanclient.donormal-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">function_name</code></em></span> <dd> <p class="para"> A registered function the worker is to execute </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">workload</code></em></span> <dd> <p class="para"> Serialized data to be processed </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">unique</code></em></span> <dd> <p class="para"> A unique ID used to identify a particular task </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-gearmanclient.donormal-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A string representing the results of running a task. </p> </div> <div class="refsect1 examples" id="refsect1-gearmanclient.donormal-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4324"> <p><strong>Example #1 Simple job submission with immediate return</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />?></span> </span> </code></div> </div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000"># Client code<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 client object.<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanClient</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Add default server (localhost).<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"Sending job\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">doNormal</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Hello!"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Success: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?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">$gmworker</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanWorker</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Add default server (localhost).<br /></span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Register function "reverse" with the server. Change the worker function to<br /># "reverse_fn_fast" for a faster worker with no output.<br /></span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></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 />print </span><span style="color: #DD0000">"Waiting for job...\n"</span><span style="color: #007700">;<br />while(</span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">work</span><span style="color: #007700">())<br />{<br /> if (</span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() != </span><span style="color: #0000BB">GEARMAN_SUCCESS</span><span style="color: #007700">)<br /> {<br /> echo </span><span style="color: #DD0000">"return_code: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> break;<br /> }<br />}<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">-></span><span style="color: #0000BB">workload</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> Starting Sending job Success: !olleH </pre></div> </div> </div> <div class="example" id="example-4325"> <p><strong>Example #2 Submitting a job and retrieving incremental status</strong></p> <div class="example-contents"><p> A job is submitted and the script loops to retrieve status information. The worker has an artificial delay which results in a long running job and sends status and data as processing occurs. Each subsequent call to <span class="methodname"><strong>GearmanClient::doNormal()</strong></span> produces status information on the running job. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000"># Client code<br /><br /># Create our client object.<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanClient</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Add default server (localhost).<br /></span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"Sending job\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000"># Send reverse job<br /></span><span style="color: #007700">do<br />{<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">doNormal</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Hello!"</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000"># Check for various return packets and errors.<br /><br /> </span><span style="color: #007700">switch(</span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">())<br /> {<br /> case </span><span style="color: #0000BB">GEARMAN_WORK_DATA</span><span style="color: #007700">:<br /> echo </span><span style="color: #DD0000">"Data: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> break;<br /> case </span><span style="color: #0000BB">GEARMAN_WORK_STATUS</span><span style="color: #007700">:<br /> list(</span><span style="color: #0000BB">$numerator</span><span style="color: #007700">, </span><span style="color: #0000BB">$denominator</span><span style="color: #007700">)= </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">doStatus</span><span style="color: #007700">();<br /> echo </span><span style="color: #DD0000">"Status: </span><span style="color: #0000BB">$numerator</span><span style="color: #DD0000">/</span><span style="color: #0000BB">$denominator</span><span style="color: #DD0000"> complete\n"</span><span style="color: #007700">;<br /> break;<br /> case </span><span style="color: #0000BB">GEARMAN_WORK_FAIL</span><span style="color: #007700">:<br /> echo </span><span style="color: #DD0000">"Failed\n"</span><span style="color: #007700">;<br /> exit;<br /> case </span><span style="color: #0000BB">GEARMAN_SUCCESS</span><span style="color: #007700">:<br /> break;<br /> default:<br /> echo </span><span style="color: #DD0000">"RET: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Error: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Errno: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">getErrno</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> exit;<br /> }<br />}<br />while(</span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() != </span><span style="color: #0000BB">GEARMAN_SUCCESS</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Success: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000"># Worker code<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">$gmworker</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanWorker</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Add default server (localhost).<br /></span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000"># Register function "reverse" with the server.<br /></span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></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 />print </span><span style="color: #DD0000">"Waiting for job...\n"</span><span style="color: #007700">;<br />while(</span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">work</span><span style="color: #007700">())<br />{<br /> if (</span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() != </span><span style="color: #0000BB">GEARMAN_SUCCESS</span><span style="color: #007700">)<br /> {<br /> echo </span><span style="color: #DD0000">"return_code: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$gmworker</span><span style="color: #007700">-></span><span style="color: #0000BB">returnCode</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> break;<br /> }<br />}<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 /> echo </span><span style="color: #DD0000">"Received job: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$job</span><span style="color: #007700">-></span><span style="color: #0000BB">handle</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$workload </span><span style="color: #007700">= </span><span style="color: #0000BB">$job</span><span style="color: #007700">-></span><span style="color: #0000BB">workload</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$workload_size </span><span style="color: #007700">= </span><span style="color: #0000BB">$job</span><span style="color: #007700">-></span><span style="color: #0000BB">workloadSize</span><span style="color: #007700">();<br /><br /> echo </span><span style="color: #DD0000">"Workload: </span><span style="color: #0000BB">$workload</span><span style="color: #DD0000"> (</span><span style="color: #0000BB">$workload_size</span><span style="color: #DD0000">)\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000"># This status loop is not needed, just showing how it works<br /> </span><span style="color: #007700">for (</span><span style="color: #0000BB">$x</span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$x </span><span style="color: #007700">< </span><span style="color: #0000BB">$workload_size</span><span style="color: #007700">; </span><span style="color: #0000BB">$x</span><span style="color: #007700">++)<br /> {<br /> echo </span><span style="color: #DD0000">"Sending status: " </span><span style="color: #007700">+ </span><span style="color: #0000BB">$x </span><span style="color: #007700">+ </span><span style="color: #0000BB">1 </span><span style="color: #007700">. </span><span style="color: #DD0000">"/</span><span style="color: #0000BB">$workload_size</span><span style="color: #DD0000"> complete\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$job</span><span style="color: #007700">-></span><span style="color: #0000BB">sendStatus</span><span style="color: #007700">(</span><span style="color: #0000BB">$x</span><span style="color: #007700">+</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">$workload_size</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$job</span><span style="color: #007700">-></span><span style="color: #0000BB">sendData</span><span style="color: #007700">(</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$workload</span><span style="color: #007700">, </span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /> }<br /><br /> </span><span style="color: #0000BB">$result</span><span style="color: #007700">= </span><span style="color: #0000BB">strrev</span><span style="color: #007700">(</span><span style="color: #0000BB">$workload</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Result: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000"># Return what we want to send back to the client.<br /> </span><span style="color: #007700">return </span><span style="color: #0000BB">$result</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents"><p> Worker output: </p></div> <div class="example-contents screen"> <div class="cdata"><pre> Starting Waiting for job... Received job: H:foo.local:106 Workload: Hello! (6) 1/6 complete 2/6 complete 3/6 complete 4/6 complete 5/6 complete 6/6 complete Result: !olleH </pre></div> </div> <div class="example-contents"><p> Client output: </p></div> <div class="example-contents screen"> <div class="cdata"><pre> Starting Sending job Status: 1/6 complete Data: H Status: 2/6 complete Data: e Status: 3/6 complete Data: l Status: 4/6 complete Data: l Status: 5/6 complete Data: o Status: 6/6 complete Data: ! Success: !olleH </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-gearmanclient.donormal-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="gearmanclient.dohigh.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doHigh()</a> - Run a single high priority task</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.dolow.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doLow()</a> - Run a single low priority task</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.dobackground.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doBackground()</a> - Run a task in the background</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.dohighbackground.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doHighBackground()</a> - Run a high priority task in the background</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.dolowbackground.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doLowBackground()</a> - Run a low priority task in the background</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.dolowbackground.html">GearmanClient::doLowBackground</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.dostatus.html">GearmanClient::doStatus</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>