<!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>Waits for signals, with a timeout</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pcntl-sigprocmask.html">pcntl_sigprocmask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-sigwaitinfo.html">pcntl_sigwaitinfo</a></div>
<div class="up"><a href="ref.pcntl.html">PCNTL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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>
<div class="refsect1 description" id="refsect1-function.pcntl-sigtimedwait-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pcntl_sigtimedwait</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$set</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$siginfo</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$seconds</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$nanoseconds</code><span class="initializer"> = 0</span></span>
]]] )</div>
<p class="para rdfs-comment">
The <span class="function"><strong>pcntl_sigtimedwait()</strong></span> function operates in exactly
the same way as <span class="function"><a href="function.pcntl-sigwaitinfo.html" class="function">pcntl_sigwaitinfo()</a></span> except that it takes
two additional parameters, <em><code class="parameter">seconds</code></em> and
<em><code class="parameter">nanoseconds</code></em>, which enable an upper bound to be placed
on the time for which the script is suspended.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pcntl-sigtimedwait-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">set</code></em></span>
<dd>
<p class="para">
Array of signals to wait for.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">siginfo</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">siginfo</code></em> is set to an array containing
informations about the signal. See
<span class="function"><a href="function.pcntl-sigwaitinfo.html" class="function">pcntl_sigwaitinfo()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">seconds</code></em></span>
<dd>
<p class="para">
Timeout in seconds.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">nanoseconds</code></em></span>
<dd>
<p class="para">
Timeout in nanoseconds.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pcntl-sigtimedwait-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, <span class="function"><strong>pcntl_sigtimedwait()</strong></span> returns a signal number.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pcntl-sigtimedwait-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pcntl-sigprocmask.html" class="function" rel="rdfs-seeAlso">pcntl_sigprocmask()</a> - Sets and retrieves blocked signals</span></li>
<li class="member"> <span class="function"><a href="function.pcntl-sigwaitinfo.html" class="function" rel="rdfs-seeAlso">pcntl_sigwaitinfo()</a> - Waits for signals</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.pcntl-sigprocmask.html">pcntl_sigprocmask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-sigwaitinfo.html">pcntl_sigwaitinfo</a></div>
<div class="up"><a href="ref.pcntl.html">PCNTL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
