<!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 for execution on each tick</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.register-shutdown-function.html">register_shutdown_function</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.unregister-tick-function.html">unregister_tick_function</a></div>
<div class="up"><a href="ref.funchand.html">Function handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.register-tick-function" class="refentry">
<div class="refnamediv">
<h1 class="refname">register_tick_function</h1>
<p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">register_tick_function</span> — <span class="dc-title">Register a function for execution on each tick</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.register-tick-function-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>register_tick_function</strong></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">$arg</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">$...</code></span>
]] )</div>
<p class="simpara">
Registers the given <em><code class="parameter">function</code></em> to be executed when a
<a href="control-structures.declare.html#control-structures.declare.ticks" class="link">tick</a> is called.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.register-tick-function-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">function</code></em></span>
<dd>
<p class="para">
The function name as a string, or an array consisting of an object and
a method.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">...</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.register-tick-function-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.register-tick-function-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5119">
<p><strong>Example #1 <span class="function"><strong>register_tick_function()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">declare(</span><span style="color: #0000BB">ticks</span><span style="color: #007700">=</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// using a function as the callback<br /></span><span style="color: #0000BB">register_tick_function</span><span style="color: #007700">(</span><span style="color: #DD0000">'my_function'</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// using an object->method<br /></span><span style="color: #0000BB">$object </span><span style="color: #007700">= new </span><span style="color: #0000BB">my_class</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">register_tick_function</span><span style="color: #007700">(array(&</span><span style="color: #0000BB">$object</span><span style="color: #007700">, </span><span style="color: #DD0000">'my_method'</span><span style="color: #007700">), </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.register-tick-function-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.0</td>
<td>
Ticks are now supported on threaded web server modules.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.register-tick-function-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
<span class="function"><strong>register_tick_function()</strong></span> should not be used with
threaded web server modules with PHP 5.2 or lower.
</p>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.register-tick-function-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="control-structures.declare.html" class="link">declare</a></li>
<li class="member"> <span class="function"><a href="function.unregister-tick-function.html" class="function" rel="rdfs-seeAlso">unregister_tick_function()</a> - De-register a function for execution on each tick</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="function.register-shutdown-function.html">register_shutdown_function</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.unregister-tick-function.html">unregister_tick_function</a></div>
<div class="up"><a href="ref.funchand.html">Function handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
