reference/sem/functions/msg-send.xml
f7e33278a909d7f7bf491f77cb10c93581091736
f7e33278a909d7f7bf491f77cb10c93581091736
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.msg-send">
3
+
<refentry xml:id="function.msg-send" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>msg_send</refname>
6
6
<refpurpose>Send a message to a message queue</refpurpose>
...
...
@@ -10,16 +10,16 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>msg_send</methodname>
13
-
<methodparam><type>resource</type><parameter>queue</parameter></methodparam>
14
-
<methodparam><type>int</type><parameter>msgtype</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>message</parameter></methodparam>
16
-
<methodparam choice="opt"><type>bool</type><parameter>serialize</parameter><initializer>true</initializer></methodparam>
17
-
<methodparam choice="opt"><type>bool</type><parameter>blocking</parameter><initializer>true</initializer></methodparam>
18
-
<methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam>
13
+
<methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
14
+
<methodparam><type>int</type><parameter>message_type</parameter></methodparam>
15
+
<methodparam><type class="union"><type>string</type><type>int</type><type>float</type><type>bool</type></type><parameter>message</parameter></methodparam>
16
+
<methodparam choice="opt"><type>bool</type><parameter>serialize</parameter><initializer>&true;</initializer></methodparam>
17
+
<methodparam choice="opt"><type>bool</type><parameter>blocking</parameter><initializer>&true;</initializer></methodparam>
18
+
<methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<para>
21
21
<function>msg_send</function> sends a <parameter>message</parameter> of type
22
-
<parameter>msgtype</parameter> (which MUST be greater than 0) to
22
+
<parameter>message_type</parameter> (which MUST be greater than 0) to
23
23
the message queue specified by <parameter>queue</parameter>.
24
24
</para>
25
25
</refsect1>
...
...
@@ -32,13 +32,15 @@
32
32
<term><parameter>queue</parameter></term>
33
33
<listitem>
34
34
<para>
35
+
The message queue.
35
36
</para>
36
37
</listitem>
37
38
</varlistentry>
38
39
<varlistentry>
39
-
<term><parameter>msgtype</parameter></term>
40
+
<term><parameter>message_type</parameter></term>
40
41
<listitem>
41
42
<para>
43
+
The type of the message (MUST be greater than 0)
42
44
</para>
43
45
</listitem>
44
46
</varlistentry>
...
...
@@ -46,7 +48,15 @@
46
48
<term><parameter>message</parameter></term>
47
49
<listitem>
48
50
<para>
51
+
The body of the message.
49
52
</para>
53
+
<note>
54
+
<para>
55
+
If <parameter>serialize</parameter> set to &false; is supplied,
56
+
MUST be of type: <type>string</type>, <type>int</type>, <type>float</type>
57
+
or <type>bool</type>. In other case a warning will be issued.
58
+
</para>
59
+
</note>
50
60
</listitem>
51
61
</varlistentry>
52
62
<varlistentry>
...
...
@@ -74,16 +84,17 @@
74
84
optional <parameter>blocking</parameter> parameter to &false;, in which
75
85
case <function>msg_send</function> will immediately return &false; if the
76
86
message is too big for the queue, and set the optional
77
-
<parameter>errorcode</parameter> to <constant>MSG_EAGAIN</constant>,
87
+
<parameter>error_code</parameter> to <constant>MSG_EAGAIN</constant>,
78
88
indicating that you should try to send your message again a little
79
89
later on.
80
90
</para>
81
91
</listitem>
82
92
</varlistentry>
83
93
<varlistentry>
84
-
<term><parameter>errorcode</parameter></term>
94
+
<term><parameter>error_code</parameter></term>
85
95
<listitem>
86
96
<para>
97
+
If the function fails, the optional errorcode will be set to the value of the system errno variable.
87
98
</para>
88
99
</listitem>
89
100
</varlistentry>
...
...
@@ -104,6 +115,31 @@
104
115
</para>
105
116
</refsect1>
106
117
118
+
<refsect1 role="changelog">
119
+
&reftitle.changelog;
120
+
<para>
121
+
<informaltable>
122
+
<tgroup cols="2">
123
+
<thead>
124
+
<row>
125
+
<entry>&Version;</entry>
126
+
<entry>&Description;</entry>
127
+
</row>
128
+
</thead>
129
+
<tbody>
130
+
<row>
131
+
<entry>8.0.0</entry>
132
+
<entry>
133
+
<parameter>queue</parameter> expects a <classname>SysvMessageQueue</classname>
134
+
instance now; previously, a <type>resource</type> was expected.
135
+
</entry>
136
+
</row>
137
+
</tbody>
138
+
</tgroup>
139
+
</informaltable>
140
+
</para>
141
+
</refsect1>
142
+
107
143
<refsect1 role="seealso">
108
144
&reftitle.seealso;
109
145
<para>
...
...
@@ -117,7 +153,6 @@
117
153
</refsect1>
118
154
119
155
</refentry>
120
-
121
156
<!-- Keep this comment at the end of the file
122
157
Local variables:
123
158
mode: sgml
124
159