<!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>Calls signal handlers for pending signals</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pcntl-setpriority.html">pcntl_setpriority</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-signal.html">pcntl_signal</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-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>
<div class="refsect1 description" id="refsect1-function.pcntl-signal-dispatch-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pcntl_signal_dispatch</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
The <span class="function"><strong>pcntl_signal_dispatch()</strong></span> function calls the signal
handlers installed by <span class="function"><a href="function.pcntl-signal.html" class="function">pcntl_signal()</a></span> for each pending
signal.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pcntl-signal-dispatch-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pcntl-signal-dispatch-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3644">
<p><strong>Example #1 <span class="function"><strong>pcntl_signal_dispatch()</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">"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"><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>
</div>
<div class="refsect1 seealso" id="refsect1-function.pcntl-signal-dispatch-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pcntl-signal.html" class="function" rel="rdfs-seeAlso">pcntl_signal()</a> - Installs a signal handler</span></li>
<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>
<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-setpriority.html">pcntl_setpriority</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pcntl-signal.html">pcntl_signal</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>
