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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 332017 $ -->
<refentry xml:id="amqpexchange.publish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::publish</refname>
<refpurpose>Publish a message to an exchange.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPExchange::publish</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam><type>string</type><parameter>routing_key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
Publish a message to the exchange represented by the <classname>AMQPExchange</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
The message to publish.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>routing_key</parameter></term>
<listitem>
<para>
The routing key to which to publish.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
One or more of <constant>AMQP_MANDATORY</constant> and
<constant>AMQP_IMMEDIATE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attributes</parameter></term>
<listitem>
<para>
<table>
<title>Supported indexes</title>
<tgroup cols="3">
<thead>
<row>
<entry>key</entry>
<entry>Description</entry>
<entry>Default value</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>content_type</emphasis></entry>
<entry></entry>
<entry><literal>text/plain</literal></entry>
</row>
<row>
<entry><emphasis>content_encoding</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>message_id</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>user_id</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>app_id</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>delivery_mode</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>priority</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>timestamp</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>expiration</emphasis></entry>
<entry>time in milliseconds</entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>type</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>reply_to</emphasis></entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry><emphasis>headers</emphasis></entry>
<entry>custom attributes to pass along with message</entry>
<entry>array</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <classname>AMQPExchangeException</classname> on failure.
</para>
<para>
Throws <classname>AMQPChannelException</classname> if the channel is not open.
</para>
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</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
-->
|
