doc-fr/reference/pcntl/functions/pcntl-waitpid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b890f28c0c6d2856eadcdc34b3faf83a846b3d79 Maintainer: dams Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pcntl-waitpid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pcntl_waitpid</refname>
  <refpurpose>Attend la fin de l'exécution d'un processus fils</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pcntl_waitpid</methodname>
   <methodparam><type>int</type><parameter>process_id</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">status</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">resource_usage</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Suspend l'exécution du processus courant jusqu'à ce qu'un processus fils
   spécifié par le paramètre <parameter>process_id</parameter> ait terminé,
   qu'un signal ait mis fin à ce processus ou qu'un signal ait appelé un gestionnaire
   de signaux.
  </para>
  <para>
   Si le processus fils identifié par <parameter>process_id</parameter> est déjà
   terminé au moment de l'appel de cette fonction (on les appelle
   des processus "zombie"), la fonction se termine immédiatement.
   Toute ressource système utilisée par le processus fils est libérée.
   Reportez-vous à la page de man waitpid(2) pour avoir des détails
   sur le comportement de cette fonction sur votre système.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>process_id</parameter></term>
     <listitem>
      <para>
       La valeur de <parameter>process_id</parameter> peut être une parmi les suivantes :
       <table>
        <title>Valeurs possibles pour <parameter>process_id</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><literal>&lt; -1</literal></entry>
           <entry>
            attend que tous les processus fils dont l'identifiant de groupe
            est égal à la valeur absolue de <parameter>process_id</parameter> soient
            terminés.
           </entry>
          </row>
          <row>
           <entry><literal>-1</literal></entry>
           <entry>
            attend que tous les processus fils soient terminés. Ceci est le
            même comportement que celui de la fonction <function>pcntl_wait</function>.
           </entry>
          </row>
          <row>
           <entry><literal>0</literal></entry>
           <entry>
            attend que tous les processus fils dont l'identifiant de groupe
            est égal à celui du processus courant soient terminés.
           </entry>
          </row>
          <row>
           <entry><literal>&gt; 0</literal></entry>
           <entry>
            attend que le processus fils dont l'identifiant est
            égal à <parameter>process_id</parameter> soit terminé.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <note>
       <para>
        Si <parameter>process_id</parameter> vaut <literal>-1</literal>, cela équivaut
        à utiliser la fonction <function>pcntl_wait</function> (moins
        <parameter>flags</parameter>).
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>status</parameter></term>
     <listitem>
      <para>
       <function>pcntl_waitpid</function> enregistrera des informations sur
       le statut courant du processus dans le paramètre
       <parameter>status</parameter>, auquel on peut accéder grâce aux
       fonctions suivantes :
       <function>pcntl_wifexited</function>,
       <function>pcntl_wifstopped</function>,
       <function>pcntl_wifsignaled</function>,
       <function>pcntl_wexitstatus</function>,
       <function>pcntl_wtermsig</function> et
       <function>pcntl_wstopsig</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Le paramètre <parameter>flags</parameter> peut prendre la valeur
       zéro, ou plusieurs des constantes globales suivantes
       (combinez les avec l'opérateur <literal>OR</literal>) :
       <table>
        <title>Valeurs possibles de <parameter>flags</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><literal>WNOHANG</literal></entry>
           <entry>
            retourne immédiatement si aucun processus fils ne s'est terminé.
           </entry>
          </row>
          <row>
           <entry><literal>WUNTRACED</literal></entry>
           <entry>
            retourne lorsque les processus fils sont arrêtés et que leur
            statut n'a pas été mis à jour.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>pcntl_waitpid</function> retourne l'identifiant de
   processus du processus fils qui s'est terminé, ou bien -1 en cas
   d'erreur ou encore zéro si <constant>WNOHANG</constant> a été utilisée
   et qu'aucun processus fils n'était disponible.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pcntl_fork</function></member>
    <member><function>pcntl_signal</function></member>
    <member><function>pcntl_wifexited</function></member>
    <member><function>pcntl_wifstopped</function></member>
    <member><function>pcntl_wifsignaled</function></member>
    <member><function>pcntl_wexitstatus</function></member>
    <member><function>pcntl_wtermsig</function></member>
    <member><function>pcntl_wstopsig</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
-->