Source of: /manual/en/function.pcntl-sigtimedwait.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-sigtimedwait.php',
1 => 'pcntl_sigtimedwait',
),
'up' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'prev' =>
array (
0 => 'function.pcntl-sigprocmask.php',
1 => 'pcntl_sigprocmask',
),
'next' =>
array (
0 => 'function.pcntl-sigwaitinfo.php',
1 => 'pcntl_sigwaitinfo',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pcntl-sigtimedwait" class="refentry">
<div class="refnamediv">
<h1 class="refname">pcntl_sigtimedwait</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">pcntl_sigtimedwait</span> — <span class="dc-title">Waits for signals, with a timeout</span></p>
</div>
<a name="function.pcntl-sigtimedwait.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_sigtimedwait</b></span>
( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$set</tt></span>
[, <span class="methodparam"><span class="type">array</span> <tt class="parameter reference">&$siginfo</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$seconds</tt><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$nanoseconds</tt><span class="initializer"> = 0</span></span>
]]] )</div>
<p class="para rdfs-comment">
The <b>pcntl_sigtimedwait()</b> function operates in exactly
the same way as <a href="function.pcntl-sigwaitinfo.php" class="function">pcntl_sigwaitinfo()</a> except that it takes
two additional parameters, <i><tt class="parameter">seconds</tt></i>
and
<i><tt class="parameter">nanoseconds</tt></i>
, which enable an upper bound to be placed
on the time for which the script is suspended.
</p>
</div>
<a name="function.pcntl-sigtimedwait.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">set</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Array of signals to wait for.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">siginfo</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <i><tt class="parameter">siginfo</tt></i>
is set to an array containing
informations about the signal. See
<a href="function.pcntl-sigwaitinfo.php" class="function">pcntl_sigwaitinfo()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">seconds</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Timeout in seconds.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">nanoseconds</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Timeout in nanoseconds.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.pcntl-sigtimedwait.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, <b>pcntl_sigtimedwait()</b> returns a signal number.
</p>
</div>
<a name="function.pcntl-sigtimedwait.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.pcntl-sigprocmask.php" class="function" rel="rdfs-seeAlso">pcntl_sigprocmask()</a> - Sets and retrieves blocked signals</li>
<li class="member"><a href="function.pcntl-sigwaitinfo.php" class="function" rel="rdfs-seeAlso">pcntl_sigwaitinfo()</a> - Waits for signals</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
