doc-fr/reference/sem/functions/msg-stat-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f7e33278a909d7f7bf491f77cb10c93581091736 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.msg-stat-queue" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msg_stat_queue</refname>
  <refpurpose>Retourne des informations sur la file de messages</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>msg_stat_queue</methodname>
   <methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>msg_stat_queue</function> retourne des informations sur la file de messages
   identifiée par <parameter>queue</parameter>. C'est une fonction pratique
   pour connaître le processus qui a émis le message qui vient d'être
   reçu.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>queue</parameter></term>
     <listitem>
      <para>
       La file des messages
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La valeur retournée par la fonction est un tableau dont les
   index et valeurs sont les suivants :
   <table>
    <title>Structure de réponse de <function>msg_stat_queue</function></title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry><literal>msg_perm.uid</literal></entry>
       <entry>
        L'uid du propriétaire de la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.gid</literal></entry>
       <entry>
        Le gid du propriétaire de la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.mode</literal></entry>
       <entry>
        Le mode d'accès à la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_stime</literal></entry>
       <entry>
        L'heure du dernier message envoyé à la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_rtime</literal></entry>
       <entry>
        L'heure du dernier message émis par la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_ctime</literal></entry>
       <entry>
        L'heure de modification de la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qnum</literal></entry>
       <entry>
        Le nombre de messages en attente dans la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qbytes</literal></entry>
       <entry>
        Le nombre d'octets maximum autorisé dans un message de la
        file d'attente. Sous Linux, cette valeur peut être lue et modifiée
        via le fichier <filename>/proc/sys/kernel/msgmnb</filename>.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lspid</literal></entry>
       <entry>
        Le pid du processus qui a envoyé le dernier message à la file.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lrpid</literal></entry>
       <entry>
        Le pid du processus qui a reçu le dernier message de la file.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   Returns &false; on failure.
  </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>8.0.0</entry>
       <entry>
        <parameter>queue</parameter> attend désormais une <classname>SysvMessageQueue</classname>;
        auparavant, une <type>resource</type> était attendue.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>msg_remove_queue</function></member>
    <member><function>msg_receive</function></member>
    <member><function>msg_get_queue</function></member>
    <member><function>msg_set_queue</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
-->