<!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>Add a high priority background task to be run in parallel</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="gearmanclient.addtaskhigh.html">GearmanClient::addTaskHigh</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.addtasklow.html">GearmanClient::addTaskLow</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.addtaskhighbackground" class="refentry"> <div class="refnamediv"> <h1 class="refname">GearmanClient::addTaskHighBackground</h1> <p class="verinfo">(PECL gearman >= 0.5.0)</p><p class="refpurpose"><span class="refname">GearmanClient::addTaskHighBackground</span> — <span class="dc-title">Add a high priority background task to be run in parallel</span></p> </div> <div class="refsect1 description" id="refsect1-gearmanclient.addtaskhighbackground-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="class.gearmantask.html" class="type GearmanTask">GearmanTask</a></span> <span class="methodname"><strong>GearmanClient::addTaskHighBackground</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"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter reference">&$context</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$unique</code></span> ]] )</div> <p class="para rdfs-comment"> Adds a high priority background task to be run in parallel with other tasks. Call this method for all the tasks to be run in parallel, then call <span class="methodname"><a href="gearmanclient.runtasks.html" class="methodname">GearmanClient::runTasks()</a></span> to perform the work. Tasks with a high priority will be selected from the queue before those of normal or low priority. </p> </div> <div class="refsect1 parameters" id="refsect1-gearmanclient.addtaskhighbackground-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">context</code></em></span> <dd> <p class="para"> Application context to associate with a task </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.addtaskhighbackground-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A <a href="class.gearmantask.html" class="classname">GearmanTask</a> object or <strong><code>FALSE</code></strong> if the task could not be added. </p> </div> <div class="refsect1 seealso" id="refsect1-gearmanclient.addtaskhighbackground-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="gearmanclient.addtask.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::addTask()</a> - Add a task to be run in parallel</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.addtaskhigh.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::addTaskHigh()</a> - Add a high priority task to run in parallel</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.addtasklow.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::addTaskLow()</a> - Add a low priority task to run in parallel</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.addtaskbackground.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::addTaskBackground()</a> - Add a background task to be run in parallel</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.addtasklowbackground.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::addTaskLowBackground()</a> - Add a low priority background task to be run in parallel</span></li> <li class="member"> <span class="methodname"><a href="gearmanclient.runtasks.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::runTasks()</a> - Run a list of tasks in parallel</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.addtaskhigh.html">GearmanClient::addTaskHigh</a></div> <div class="next" style="text-align: right; float: right;"><a href="gearmanclient.addtasklow.html">GearmanClient::addTaskLow</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>