<!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>Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanworker.returncode.html">GearmanWorker::returnCode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.setoptions.html">GearmanWorker::setOptions</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="function.func-name" class="refentry">
<div class="refnamediv">
<h1 class="refname">GearmanWorker::setId</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">GearmanWorker::setId</span> — <span class="dc-title">Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers.</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.func-name-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::setId</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
)</div>
<p class="para rdfs-comment">
Assigns the worker an identifier.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.func-name-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">id</code></em></span>
<dd>
<p class="para">
A string identifier.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.func-name-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-function.func-name-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4331">
<p><strong>Example #1 <span class="function"><strong>GearmanWorker::setId()</strong></span> example</strong></p>
<div class="example-contents"><p>
Set an identifier for a simple worker.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$worker</span><span style="color: #007700">= new </span><span style="color: #0000BB">GearmanWorker</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$worker</span><span style="color: #007700">-></span><span style="color: #0000BB">setId</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">);<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>
Run the following command:
gearadmin --workers
Output:
30 ::3a3a:3361:3361:3a33%976303667 - : test
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanworker.returncode.html">GearmanWorker::returnCode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.setoptions.html">GearmanWorker::setOptions</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>
