Source of: /manual/en/function.pcntl-sigprocmask.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-sigprocmask.php',
1 => 'pcntl_sigprocmask',
),
'up' =>
array (
0 => 'ref.pcntl.php',
1 => 'PCNTL Functions',
),
'prev' =>
array (
0 => 'function.pcntl-signal.php',
1 => 'pcntl_signal',
),
'next' =>
array (
0 => 'function.pcntl-sigtimedwait.php',
1 => 'pcntl_sigtimedwait',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pcntl-sigprocmask" class="refentry">
<div class="refnamediv">
<h1 class="refname">pcntl_sigprocmask</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">pcntl_sigprocmask</span> — <span class="dc-title">Sets and retrieves blocked signals</span></p>
</div>
<a name="function.pcntl-sigprocmask.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_sigprocmask</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$how</tt></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">&$oldset</tt></span>
] )</div>
<p class="para rdfs-comment">
The <b>pcntl_sigprocmask()</b> function adds, removes or sets blocked
signals, depending on the <i><tt class="parameter">how</tt></i>
parameter.
</p>
</div>
<a name="function.pcntl-sigprocmask.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">how</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Sets the behavior of <b>pcntl_sigprocmask()</b>. Possible
values:
</p><ul class="simplelist">
<li class="member"><b><tt class="constant">SIG_BLOCK</tt></b>: Add the signals to the
currently blocked signals.</li>
<li class="member"><b><tt class="constant">SIG_UNBLOCK</tt></b>: Remove the signals from the
currently blocked signals.</li>
<li class="member"><b><tt class="constant">SIG_SETMASK</tt></b>: Replace the currently
blocked signals by the given list of signals.</li>
</ul><p>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">set</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
List of signals.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">oldset</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <i><tt class="parameter">oldset</tt></i>
parameter is set to an array
containing the list of the previously blocked signals.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.pcntl-sigprocmask.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-sigprocmask.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>pcntl_sigprocmask()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />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 /></span><span style="color: #0000BB">$oldset </span><span style="color: #007700">= array();<br /></span><span style="color: #0000BB">pcntl_sigprocmask</span><span style="color: #007700">(</span><span style="color: #0000BB">SIG_UNBLOCK</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SIGHUP</span><span style="color: #007700">), </span><span style="color: #0000BB">$oldset</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.pcntl-sigprocmask.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-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(); ?>
