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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.proc-nice" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>proc_nice</refname>
<refpurpose>Change the priority of the current process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>proc_nice</methodname>
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
</methodsynopsis>
<para>
<function>proc_nice</function> changes the priority of the current
process by the amount specified in <parameter>priority</parameter>. A
positive <parameter>priority</parameter> will lower the priority of the
current process, whereas a negative <parameter>priority</parameter>
will raise the priority.
</para>
<para>
<function>proc_nice</function> is not related to
<function>proc_open</function> and its associated functions in any way.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>priority</parameter></term>
<listitem>
<para>
The new priority value, the value of this may differ on platforms.
</para>
<para>
On Unix, a low value, such as <literal>-20</literal> means high priority
whereas positive values have a lower priority.
</para>
<para>
For Windows the <parameter>priority</parameter> parameter has the
following meaning:
</para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry valign="top">Priority class</entry>
<entry valign="top">Possible values</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top">High priority</entry>
<entry valign="top">
<parameter>priority</parameter> <literal>< -9</literal>
</entry>
</row>
<row>
<entry valign="top">Above normal priority</entry>
<entry valign="top">
<parameter>priority</parameter> <literal>< -4</literal>
</entry>
</row>
<row>
<entry valign="top">Normal priority</entry>
<entry valign="top">
<parameter>priority</parameter> <literal>< 5</literal> &
<parameter>priority</parameter> <literal>> -5</literal>
</entry>
</row>
<row>
<entry valign="top">Below normal priority</entry>
<entry valign="top">
<parameter>priority</parameter> <literal>> 5</literal>
</entry>
</row>
<row>
<entry valign="top">Idle priority</entry>
<entry valign="top">
<parameter>priority</parameter> <literal>> 9</literal>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
If an error occurs, like the user lacks permission to change the priority,
an error of level <constant>E_WARNING</constant> is also generated.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.2.0</entry>
<entry>
This function is now available on Windows.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using <function>proc_nice</function> to set the process priority to high</title>
<programlisting role="php">
<![CDATA[
<?php
// Highest priority
proc_nice(-20);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<title>Availability</title>
<para>
<function>proc_nice</function> will only exist if your system has 'nice'
capabilities. 'nice' conforms to: SVr4, SVID EXT, AT&T, X/OPEN, BSD
4.3.
</para>
</note>
<note>
<title>Windows only</title>
<para>
<function>proc_nice</function> will change the current <emphasis>process</emphasis>
priority, even if PHP was compiled using thread safety.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_setpriority</function></member>
</simplelist>
</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
-->
|
