<!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 a function with the job server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="gearmanworker.options.html">GearmanWorker::options</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.removeoptions.html">GearmanWorker::removeOptions</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.register" class="refentry">
<div class="refnamediv">
<h1 class="refname">GearmanWorker::register</h1>
<p class="verinfo">(PECL gearman >= 0.6.0)</p><p class="refpurpose"><span class="refname">GearmanWorker::register</span> — <span class="dc-title">Register a function with the job server</span></p>
</div>
<div class="refsect1 description" id="refsect1-gearmanworker.register-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::register</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$function_name</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 with an optional timeout. The timeout
specifies how many seconds the server will wait before marking a job as failed.
If the timeout is set to zero, there is no timeout.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-gearmanworker.register-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">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.register-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A standard Gearman return value.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-gearmanworker.register-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="gearmanworker.unregister.html" class="methodname" rel="rdfs-seeAlso">GearmanWorker::unregister()</a> - Unregister a function name with the job servers</span></li>
<li class="member"> <span class="methodname"><a href="gearmanworker.unregisterall.html" class="methodname" rel="rdfs-seeAlso">GearmanWorker::unregisterAll()</a> - Unregister all function names with the job servers</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="gearmanworker.options.html">GearmanWorker::options</a></div>
<div class="next" style="text-align: right; float: right;"><a href="gearmanworker.removeoptions.html">GearmanWorker::removeOptions</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>
