1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<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 number of bytes of space currently available in the queue to
hold sent messages until they are received.
</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:"../../../../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
-->
|
