1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pcntl-sigprocmask" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_sigprocmask</refname>
<refpurpose>Sets and retrieves blocked signals</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pcntl_sigprocmask</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>array</type><parameter>signals</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">old_signals</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
The <function>pcntl_sigprocmask</function> function adds, removes or sets blocked
signals, depending on the <parameter>mode</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Sets the behavior of <function>pcntl_sigprocmask</function>. Possible
values:
<simplelist>
<member><constant>SIG_BLOCK</constant>: Add the signals to the
currently blocked signals.</member>
<member><constant>SIG_UNBLOCK</constant>: Remove the signals from the
currently blocked signals.</member>
<member><constant>SIG_SETMASK</constant>: Replace the currently
blocked signals by the given list of signals.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signals</parameter></term>
<listitem>
<para>
List of signals.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>old_signals</parameter></term>
<listitem>
<para>
The <parameter>old_signals</parameter> parameter is set to an array
containing the list of the previously blocked signals.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
is empty.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>TypeError</classname> is thrown if <parameter>signal</parameter>
value is not an <type>int</type>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
value is invalid.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>mode</parameter>
value is not <constant>SIG_BLOCK</constant>, <constant>SIG_UNBLOCK</constant> or
<constant>SIG_SETMASK</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pcntl_sigprocmask</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
pcntl_sigprocmask(SIG_BLOCK, array(SIGHUP));
$oldset = array();
pcntl_sigprocmask(SIG_UNBLOCK, array(SIGHUP), $oldset);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pcntl_sigwaitinfo</function></member>
<member><function>pcntl_sigtimedwait</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
