Source of: /manual/en/function.pcntl-sigwaitinfo.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-sigwaitinfo.php',
1 => 'pcntl_sigwaitinfo',
),
'up' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'prev' =>
array (
0 => 'function.pcntl-sigtimedwait.php',
1 => 'pcntl_sigtimedwait',
),
'next' =>
array (
0 => 'function.pcntl-wait.php',
1 => 'pcntl_wait',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.pcntl-sigwaitinfo.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_sigwaitinfo</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>
] )</div>
<p class="para rdfs-comment">
The <b>pcntl_sigwaitinfo()</b> function suspends execution of the
calling script until one of the signals given in <i><tt class="parameter">set</tt></i>
are delivered. If one of the signal is already pending (e.g. blocked by
<a href="function.pcntl-sigprocmask.php" class="function">pcntl_sigprocmask()</a>),
<b>pcntl_sigwaitinfo()</b> will return immediately.
</p>
</div>
<a name="function.pcntl-sigwaitinfo.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>
parameter is set to an array containing
informations about the signal.
</p>
<p class="para">
The following elements are set for all signals:
</p><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>
<p class="para">
The following elements may be set for the <b><tt class="constant">SIGCHLD</tt></b> signal:
</p><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>
<p class="para">
The following elements may be set for the <b><tt class="constant">SIGILL</tt></b>,
<b><tt class="constant">SIGFPE</tt></b>, <b><tt class="constant">SIGSEGV</tt></b> and
<b><tt class="constant">SIGBUS</tt></b> signals:
</p><ul class="simplelist">
<li class="member">addr: Memory location which caused fault</li>
</ul><p>
</p>
<p class="para">
The following element may be set for the <b><tt class="constant">SIGPOLL</tt></b>
signal:
</p><ul class="simplelist">
<li class="member">band: Band event</li>
<li class="member">fd: File descriptor number</li>
</ul><p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.pcntl-sigwaitinfo.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, <b>pcntl_sigwaitinfo()</b> returns a signal number.
</p>
</div>
<a name="function.pcntl-sigwaitinfo.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>pcntl_sigwaitinfo()</b> example</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.pcntl-sigwaitinfo.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-sigtimedwait.php" class="function" rel="rdfs-seeAlso">pcntl_sigtimedwait()</a> - Waits for signals, with a timeout</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
