proc-nice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4ecb2c1b4ba1b51c5e9678a7908e001df9bc92f5 Maintainer: shimooka Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.proc-nice" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>proc_nice</refname>
  <refpurpose>現在のプロセスの優先度を変更する</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> は、現在のプロセスの優先度を
   <parameter>priority</parameter> で指定された値に変更します。
   <parameter>priority</parameter> が正数の場合、
   現在のプロセスの優先度をより低くし、<parameter>priority</parameter>
   が負数の場合は優先度が上がります。
  </para>
  <para>
   <function>proc_nice</function> は、<function>proc_open</function>
   やそれに関連する関数とは関係ありません。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>priority</parameter></term>
     <listitem>
      <para>
       新しい優先度の値。この値はプラットフォームによっては異なるかもしれません。
      </para>
      <para>
       Unix 上では、<literal>-20</literal> のように低い値が高い優先度である一方で、
       正の値は低い優先度として扱われます。
      </para>
      <para>
       Windows では、
       <parameter>priority</parameter> パラメータは次のような意味があります:
      </para>
      <informaltable>
       <tgroup cols="3">
        <thead>
         <row>
          <entry valign="top">優先度クラス</entry>
          <entry valign="top">取りうる値</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry valign="top">優先度高</entry>
          <entry valign="top">
           <parameter>priority</parameter> <literal>&lt; -9</literal>
          </entry>
         </row>
         <row>
          <entry valign="top">通常より高い優先度</entry>
          <entry valign="top">
           <parameter>priority</parameter> <literal>&lt; -4</literal>
          </entry>
         </row>
         <row>
          <entry valign="top">通常の優先度</entry>
          <entry valign="top">
           <parameter>priority</parameter> <literal>&lt; 5</literal> &amp; 
           <parameter>priority</parameter> <literal>&gt; -5</literal>
          </entry>
         </row>
         <row>
          <entry valign="top">通常より低い優先度</entry>
          <entry valign="top">
           <parameter>priority</parameter> <literal>&gt; 5</literal>
          </entry>
         </row>
         <row>
          <entry valign="top">アイドルな優先度</entry>
          <entry valign="top">
           <parameter>priority</parameter> <literal>&gt; 9</literal>
          </entry>
         </row>
        </tbody>
       </tgroup>
      </informaltable>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   ユーザーが優先度を変更する権限を持っていないなど、
   エラーが発生した場合は <constant>E_WARNING</constant>
   レベルのエラーも発行されます。
  </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>
        この関数は、Windows で利用できるようになりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>proc_nice</function> 関数を使い、プロセスの優先度を高に設定する</title>
    <programlisting role="php">
<![CDATA[
<?php
// Highest priority
proc_nice(-20);
?>
]]>
    </programlisting>
   </example>
  </para>

 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>可用性</title>
   <para>
    <function>proc_nice</function> は、使用しているシステムが 'nice'
    の機能を持っている場合のみ利用可能です。
    'nice' は次のシステムに準拠しています:
    SVr4, SVID EXT, AT&amp;T, X/OPEN, BSD 4.3 。
   </para>
  </note>
  <note>
   <title>Windows のみ</title>
   <para>
    <function>proc_nice</function> 関数は、
    PHP がたとえスレッドセーフを有効にしてコンパイルされていたとしても、
    現在の <emphasis>プロセス</emphasis> の優先度を変更します。
   </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
-->