mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
1338995a49
Flesh out the ftok docs and add see-also links to relevant functions. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@80428 c90b9560-bf6c-de11-be94-00142212c4b1
125 lines
3.4 KiB
XML
125 lines
3.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
<refentry id="function.msg-stat-queue">
|
|
<refnamediv>
|
|
<refname>msg_stat_queue</refname>
|
|
<refpurpose>
|
|
Returns information from the message queue data structure
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msg_stat_queue</methodname>
|
|
<methodparam><type>int</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>
|
|
<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>msg_perm.uid</entry>
|
|
<entry>
|
|
The uid of the owner of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_perm.gid</entry>
|
|
<entry>
|
|
The gid of the owner of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_perm.mode</entry>
|
|
<entry>
|
|
The file access mode of the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_stime</entry>
|
|
<entry>
|
|
The time that the last message was sent to the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_rtime</entry>
|
|
<entry>
|
|
The time that the last message was received from the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_ctime</entry>
|
|
<entry>
|
|
The time that the queue was last changed.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_qnum</entry>
|
|
<entry>
|
|
The number of messages waiting to be read from the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_qbytes</entry>
|
|
<entry>
|
|
The number of bytes of space currently available in the queue to
|
|
hold sent messages until they are received.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_lspid</entry>
|
|
<entry>
|
|
The pid of the process that sent the last message to the queue.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>msg_lrpid</entry>
|
|
<entry>
|
|
The pid of the process that received the last message from the queue.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
See also: <function>msg_remove_queue</function>,
|
|
<function>msg_receive</function>,
|
|
<function>msg_stat_queue</function> and
|
|
<function>msg_set_queue</function>.
|
|
</para>
|
|
<para>
|
|
This function was introduced in PHP 4.3.0 (not yet released).
|
|
</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:"../../../../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
|
|
-->
|