msg-stat-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f7e33278a909d7f7bf491f77cb10c93581091736 Maintainer: hholzgra Status: ready -->
<refentry xml:id="function.msg-stat-queue" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msg_stat_queue</refname>
  <refpurpose>
   Liefert Informationen zur Datenstruktur einer Nachrichten-Warteschlange
  </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> liefert die Metadaten zu der mit
   <parameter>queue</parameter> angegebenen Nachrichten-Warteschlange. Diese
   Informationen können &zb; genutzt werden, um herauszufinden welcher Prozess
   eine gerade empfangene Nachricht gesendet hat.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>queue</parameter></term>
     <listitem>
      <para>
       Die Nachrichten-Warteschlange.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Bei Erfolg ist der Rückgabewert ein Array, dessen Schlüssel und Werte die
   folgende Bedeutung haben:
   <table>
    <title>Die Array-Struktur für msg_stat_queue</title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry><literal>msg_perm.uid</literal></entry>
       <entry>
        Die Benutzer-ID des Besitzers der Warteschlange.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.gid</literal></entry>
       <entry>
        Die Gruppen-ID des Besitzers der Warteschlange.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.mode</literal></entry>
       <entry>
        Der Dateizugriffsmodus der Warteschlange.
       </entry>
      </row>
      <row>
       <entry><literal>msg_stime</literal></entry>
       <entry>
        Der Zeitpunkt, zu dem die letzte Nachricht an die
        Warteschlange gesendet wurde.
       </entry>
      </row>
      <row>
       <entry><literal>msg_rtime</literal></entry>
       <entry>
        Der Zeitpunkt, zu dem die letzte Nachricht von der
        Warteschlange empfangen wurde.
       </entry>
      </row>
      <row>
       <entry><literal>msg_ctime</literal></entry>
       <entry>
        Der Zeitpunkt, zu dem sich der Status der Warteschlange
        zuletzt geändert hat.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qnum</literal></entry>
       <entry>
        Die Anzahl der Nachrichten, die sich zur Zeit noch
        in der Warteschlange befinden.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qbytes</literal></entry>
       <entry>
        Die maximal erlaubte Anzahl von Bytes in einer
        Nachrichten-Warteschlange. Unter Linux kann dieser Wert über
        <filename>/proc/sys/kernel/msgmnb</filename> gelesen und verändert
        werden.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lspid</literal></entry>
       <entry>
        Die Prozess-ID des Prozesses, der die letzte Nachricht an die
        Warteschlange gesendet hat.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lrpid</literal></entry>
       <entry>
        Die Prozess-ID des Prozesses, der die letzte Nachricht aus der
        Warteschlange empfangen hat.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   Gibt bei Auftreten eines Fehlers &false; zurück.
  </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> erwartet nun eine
        <classname>SysvMessageQueue</classname>-Instanz; vorher wurde eine
        <type>resource</type> erwartet.
       </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
-->