mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
3.9 KiB
XML
149 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.msg-stat-queue">
|
|
<refnamediv>
|
|
<refname>msg_stat_queue</refname>
|
|
<refpurpose>Returns information from the message queue data structure</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msg_stat_queue</methodname>
|
|
<methodparam><type>resource</type><parameter>queue</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>msg_stat_queue</function> returns the message queue meta data
|
|
for the message queue specified by the <parameter>queue</parameter>.
|
|
This is useful, for example, to determine which process sent the message
|
|
that was just received.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>queue</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Message queue resource handle
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The return value is an array whose keys and values have the following
|
|
meanings:
|
|
<table>
|
|
<title>Array structure for msg_stat_queue</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><literal>msg_perm.uid</literal></entry>
|
|
<entry>
|
|
The uid of the owner of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_perm.gid</literal></entry>
|
|
<entry>
|
|
The gid of the owner of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_perm.mode</literal></entry>
|
|
<entry>
|
|
The file access mode of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_stime</literal></entry>
|
|
<entry>
|
|
The time that the last message was sent to the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_rtime</literal></entry>
|
|
<entry>
|
|
The time that the last message was received from the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_ctime</literal></entry>
|
|
<entry>
|
|
The time that the queue was last changed.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_qnum</literal></entry>
|
|
<entry>
|
|
The number of messages waiting to be read from the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_qbytes</literal></entry>
|
|
<entry>
|
|
The maximum number of bytes allowed in one message queue. On
|
|
Linux, this value may be read and modified via
|
|
<filename>/proc/sys/kernel/msgmnb</filename>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_lspid</literal></entry>
|
|
<entry>
|
|
The pid of the process that sent the last message to the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>msg_lrpid</literal></entry>
|
|
<entry>
|
|
The pid of the process that received the last message from the queue.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</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
|
|
-->
|