<!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</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pcntl-sigtimedwait.html">pcntl_sigtimedwait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-strerror.html">pcntl_strerror</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-sigwaitinfo" class="refentry">
<div class="refnamediv">
<h1 class="refname">pcntl_sigwaitinfo</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">pcntl_sigwaitinfo</span> — <span class="dc-title">Waits for signals</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pcntl-sigwaitinfo-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pcntl_sigwaitinfo</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>
] )</div>
<p class="para rdfs-comment">
The <span class="function"><strong>pcntl_sigwaitinfo()</strong></span> function suspends execution of the
calling script until one of the signals given in <em><code class="parameter">set</code></em>
are delivered. If one of the signal is already pending (e.g. blocked by
<span class="function"><a href="function.pcntl-sigprocmask.html" class="function">pcntl_sigprocmask()</a></span>),
<span class="function"><strong>pcntl_sigwaitinfo()</strong></span> will return immediately.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pcntl-sigwaitinfo-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> parameter is set to an array containing
informations about the signal.
</p>
<p class="para">
The following elements are set for all signals:
<ul class="simplelist">
<li class="member">signo: Signal number</li>
<li class="member">errno: An error number</li>
<li class="member">code: Signal code</li>
</ul>
</p>
<p class="para">
The following elements may be set for the <strong><code>SIGCHLD</code></strong> signal:
<ul class="simplelist">
<li class="member">status: Exit value or signal</li>
<li class="member">utime: User time consumed</li>
<li class="member">stime: System time consumed</li>
<li class="member">pid: Sending process ID</li>
<li class="member">uid: Real user ID of sending process</li>
</ul>
</p>
<p class="para">
The following elements may be set for the <strong><code>SIGILL</code></strong>,
<strong><code>SIGFPE</code></strong>, <strong><code>SIGSEGV</code></strong> and
<strong><code>SIGBUS</code></strong> signals:
<ul class="simplelist">
<li class="member">addr: Memory location which caused fault</li>
</ul>
</p>
<p class="para">
The following element may be set for the <strong><code>SIGPOLL</code></strong>
signal:
<ul class="simplelist">
<li class="member">band: Band event</li>
<li class="member">fd: File descriptor number</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pcntl-sigwaitinfo-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, <span class="function"><strong>pcntl_sigwaitinfo()</strong></span> returns a signal number.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pcntl-sigwaitinfo-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3647">
<p><strong>Example #1 <span class="function"><strong>pcntl_sigwaitinfo()</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">echo </span><span style="color: #DD0000">"Blocking SIGHUP signal\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">pcntl_sigprocmask</span><span style="color: #007700">(</span><span style="color: #0000BB">SIG_BLOCK</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SIGHUP</span><span style="color: #007700">));<br /><br />echo </span><span style="color: #DD0000">"Sending SIGHUP to self\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">posix_kill</span><span style="color: #007700">(</span><span style="color: #0000BB">posix_getpid</span><span style="color: #007700">(), </span><span style="color: #0000BB">SIGHUP</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Waiting for signals\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= array();<br /></span><span style="color: #0000BB">pcntl_sigwaitinfo</span><span style="color: #007700">(array(</span><span style="color: #0000BB">SIGHUP</span><span style="color: #007700">), </span><span style="color: #0000BB">$info</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pcntl-sigwaitinfo-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-sigtimedwait.html" class="function" rel="rdfs-seeAlso">pcntl_sigtimedwait()</a> - Waits for signals, with a timeout</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-sigtimedwait.html">pcntl_sigtimedwait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-strerror.html">pcntl_strerror</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>
