<!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 task in the background</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.do.html">GearmanClient::do</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanclient.dohigh.html">GearmanClient::doHigh</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.dobackground" class="refentry">
<div class="refnamediv">
<h1 class="refname">GearmanClient::doBackground</h1>
<p class="verinfo">(PECL gearman >= 0.5.0)</p><p class="refpurpose"><span class="refname">GearmanClient::doBackground</span> — <span class="dc-title">Run a task in the background</span></p>
</div>
<div class="refsect1 description" id="refsect1-gearmanclient.dobackground-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::doBackground</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 task in the background, returning a job handle which can be used
to get the status of the running task.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-gearmanclient.dobackground-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.dobackground-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The job handle for the submitted task.
</p>
</div>
<div class="refsect1 examples" id="refsect1-gearmanclient.dobackground-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4323">
<p><strong>Example #1 Submit and monitor a background job</strong></p>
<div class="example-contents"><p>
The worker in this example has an artificial delay introduced to mimic
a long running job. The client script periodically checks the status
of 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">/* create our 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 the default server */<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 /></span><span style="color: #FF8000">/* run reverse client */<br /></span><span style="color: #0000BB">$job_handle </span><span style="color: #007700">= </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">doBackground</span><span style="color: #007700">(</span><span style="color: #DD0000">"reverse"</span><span style="color: #007700">, </span><span style="color: #DD0000">"this is a test"</span><span style="color: #007700">);<br /><br />if (</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">"bad return code\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /><br /></span><span style="color: #0000BB">$done </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />do<br />{<br /> </span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$stat </span><span style="color: #007700">= </span><span style="color: #0000BB">$gmclient</span><span style="color: #007700">-></span><span style="color: #0000BB">jobStatus</span><span style="color: #007700">(</span><span style="color: #0000BB">$job_handle</span><span style="color: #007700">);<br /> if (!</span><span style="color: #0000BB">$stat</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]) </span><span style="color: #FF8000">// the job is known so it is not done<br /> </span><span style="color: #0000BB">$done </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Running: " </span><span style="color: #007700">. (</span><span style="color: #0000BB">$stat</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] ? </span><span style="color: #DD0000">"true" </span><span style="color: #007700">: </span><span style="color: #DD0000">"false"</span><span style="color: #007700">) . </span><span style="color: #DD0000">", numerator: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$stat</span><span style="color: #007700">[</span><span style="color: #0000BB">2</span><span style="color: #007700">] . </span><span style="color: #DD0000">", denomintor: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$stat</span><span style="color: #007700">[</span><span style="color: #0000BB">3</span><span style="color: #007700">] . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br />while(!</span><span style="color: #0000BB">$done</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"done!\n"</span><span style="color: #007700">;<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>
Running: true, numerator: 3, denomintor: 14
Running: true, numerator: 6, denomintor: 14
Running: true, numerator: 9, denomintor: 14
Running: true, numerator: 12, denomintor: 14
Running: false, numerator: 0, denomintor: 0
done!
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-gearmanclient.dobackground-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="gearmanclient.donormal.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::doNormal()</a> - Run a single task and return a result</span></li>
<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.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.do.html">GearmanClient::do</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanclient.dohigh.html">GearmanClient::doHigh</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>
