<!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>Register and add callback function</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.gearmanworker.html">GearmanWorker</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.addoptions.html">GearmanWorker::addOptions</a></div>
<div class="up"><a href="class.gearmanworker.html">GearmanWorker</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="gearmanworker.addfunction" class="refentry">
<div class="refnamediv">
<h1 class="refname">GearmanWorker::addFunction</h1>
<p class="verinfo">(PECL gearman >= 0.5.0)</p><p class="refpurpose"><span class="refname">GearmanWorker::addFunction</span> — <span class="dc-title">Register and add callback function</span></p>
</div>
<div class="refsect1 description" id="refsect1-gearmanworker.addfunction-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>GearmanWorker::addFunction</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$function_name</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$function</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">int</span> <code class="parameter">$timeout</code></span>
]] )</div>
<p class="para rdfs-comment">
Registers a function name with the job server and specifies a callback corresponding to that
function. Optionally specify extra application context data to be used when the callback is
called and a timeout.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-gearmanworker.addfunction-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">
The name of a function to register with the job server
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">function</code></em></span>
<dd>
<p class="para">
A callback that gets called when a job for the registered function name is submitted
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
A reference to arbitrary application context data that can be modified by the worker function
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">timeout</code></em></span>
<dd>
<p class="para">
An interval of time in seconds
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-gearmanworker.addfunction-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 examples" id="refsect1-gearmanworker.addfunction-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4328">
<p><strong>Example #1 Simple worker making use of extra application context data</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000"># get a gearman worker<br /></span><span style="color: #0000BB">$worker</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 the default server (localhost)<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(); <br /><br /></span><span style="color: #FF8000"># define a variable to hold application data<br /></span><span style="color: #0000BB">$count</span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; <br /><br /></span><span style="color: #FF8000"># add the "reverse" function<br /></span><span style="color: #0000BB">$worker</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_cb"</span><span style="color: #007700">, &</span><span style="color: #0000BB">$count</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000"># start the worker<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$worker</span><span style="color: #007700">-></span><span style="color: #0000BB">work</span><span style="color: #007700">());<br /><br />function </span><span style="color: #0000BB">reverse_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$job</span><span style="color: #007700">, </span><span style="color: #0000BB">$count</span><span style="color: #007700">) <br />{ <br /> </span><span style="color: #0000BB">$count</span><span style="color: #007700">++; <br /> return </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$count</span><span style="color: #DD0000">: " </span><span style="color: #007700">. </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>
Running a client that submits two jobs for the reverse function would have
output similar to the following:
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
1: olleh
2: dlrow
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-gearmanworker.addfunction-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="gearmanclient.do.html" class="methodname" rel="rdfs-seeAlso">GearmanClient::do()</a> - Run a single task and return a result [deprecated]</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="class.gearmanworker.html">GearmanWorker</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.addoptions.html">GearmanWorker::addOptions</a></div>
<div class="up"><a href="class.gearmanworker.html">GearmanWorker</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
