Source of: /manual/en/function.pcntl-alarm.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pcntl.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.pcntl-alarm.php',
1 => 'pcntl_alarm',
),
'up' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'prev' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'next' =>
array (
0 => 'function.pcntl-exec.php',
1 => 'pcntl_exec',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pcntl-alarm" class="refentry">
<div class="refnamediv">
<h1 class="refname">pcntl_alarm</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">pcntl_alarm</span> — <span class="dc-title">Set an alarm clock for delivery of a signal</span></p>
</div>
<a name="function.pcntl-alarm.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>pcntl_alarm</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$seconds</tt></span>
)</div>
<p class="para rdfs-comment">
Creates a timer that will send a <b><tt class="constant">SIGALRM</tt></b> signal to
the process after the given number of seconds.
Any call to <b>pcntl_alarm()</b> will cancel any previously
set alarm.
</p>
</div>
<a name="function.pcntl-alarm.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">seconds</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The number of seconds to wait. If <i><tt class="parameter">seconds</tt></i>
is
zero, no new alarm is created.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.pcntl-alarm.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the time in seconds that any previously scheduled alarm had
remaining before it was to be delivered, or <i>0</i> if there
was no previously scheduled alarm.
</p>
</div>
</div><?php manual_footer(); ?>
