Source of: /manual/en/function.pcntl-signal-dispatch.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-signal-dispatch.php',
1 => 'pcntl_signal_dispatch',
),
'up' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'prev' =>
array (
0 => 'function.pcntl-setpriority.php',
1 => 'pcntl_setpriority',
),
'next' =>
array (
0 => 'function.pcntl-signal.php',
1 => 'pcntl_signal',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pcntl-signal-dispatch" class="refentry">
<div class="refnamediv">
<h1 class="refname">pcntl_signal_dispatch</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">pcntl_signal_dispatch</span> — <span class="dc-title">Calls signal handlers for pending signals</span></p>
</div>
<a name="function.pcntl-signal-dispatch.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>pcntl_signal_dispatch</b></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
The <b>pcntl_signal_dispatch()</b> function calls the signal
handlers installed by <a href="function.pcntl-signal.php" class="function">pcntl_signal()</a> for each pending
signal.
</p>
</div>
<a name="function.pcntl-signal-dispatch.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.pcntl-signal-dispatch.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>pcntl_signal_dispatch()</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">"Installing signal handler...\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">pcntl_signal</span><span style="color: #007700">(</span><span style="color: #0000BB">SIGHUP</span><span style="color: #007700">, function(</span><span style="color: #0000BB">$signo</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"signal handler called\n"</span><span style="color: #007700">;<br />});<br /><br />echo </span><span style="color: #DD0000">"Generating signal 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">"Dispatching...\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">pcntl_signal_dispatch</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"Done\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Installing signal handler...
Generating signal SIGHUP to self...
Dispatching...
signal handler called
Done
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.pcntl-signal-dispatch.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-signal.php" class="function" rel="rdfs-seeAlso">pcntl_signal()</a> - Installs a signal handler</li>
<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>
<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(); ?>
