msg-stat-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f7e33278a909d7f7bf491f77cb10c93581091736 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.msg-stat-queue" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msg_stat_queue</refname>
  <refpurpose>メッセージキューデータ構造体の情報を返す</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> は、<parameter>queue</parameter>
   で指定したメッセージキューのメタデータを返します。
   これは、例えば受信したメッセージがどのプロセスから送信されたのかを調べる場合などに有用です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>queue</parameter></term>
     <listitem>
      <para>
       メッセージキュー
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合、戻り値は配列で、そのキーと値は以下のような意味をもちます。

   <table>
    <title>msg_stat_queue の配列構造</title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry><literal>msg_perm.uid</literal></entry>
       <entry>
        キューの所有者の uid 。
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.gid</literal></entry>
       <entry>
        キューの所有者の gid 。
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.mode</literal></entry>
       <entry>
        キューのファイルアクセスモード。
       </entry>
      </row>
      <row>
       <entry><literal>msg_stime</literal></entry>
       <entry>
        キューに対して最後にメッセージが送信された時刻。
       </entry>
      </row>
      <row>
       <entry><literal>msg_rtime</literal></entry>
       <entry>
        キューから最後にメッセージを受信した時刻。
       </entry>
      </row>
      <row>
       <entry><literal>msg_ctime</literal></entry>
       <entry>
        キューが最後に更新された時刻。
       </entry>
      </row>
      <row>
       <entry><literal>msg_qnum</literal></entry>
       <entry>
        キューにある読み込み待ちのメッセージの数。
       </entry>
      </row>
      <row>
       <entry><literal>msg_qbytes</literal></entry>
       <entry>
        ひとつのメッセージキューに含められる最大のバイト数。
        Linux では、この値の取得や設定を
        <filename>/proc/sys/kernel/msgmnb</filename> で行えます。
       </entry>
      </row>
      <row>
       <entry><literal>msg_lspid</literal></entry>
       <entry>
        最後にキューに対してメッセージを送信したプロセスの pid 。
       </entry>
      </row>
      <row>
       <entry><literal>msg_lrpid</literal></entry>
       <entry>
        最後にキューからメッセージを受信したプロセスの pid 。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   失敗時に &false; を返します。
  </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> は、
        <classname>SysvMessageQueue</classname> のインスタンスを期待するようになりました。
        これより前のバージョンでは、リソースが期待されていました。
       </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
-->