You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kg...@apache.org on 2011/12/19 22:21:34 UTC
svn commit: r1220953 - in /qpid/trunk/qpid/doc/book/src:
Message-Groups-Guide.xml Using-message-groups.xml
Author: kgiusti
Date: Mon Dec 19 21:21:34 2011
New Revision: 1220953
URL: http://svn.apache.org/viewvc?rev=1220953&view=rev
Log:
NO-JIRA: reformat examples in the docs to fit in PDF output.
Modified:
qpid/trunk/qpid/doc/book/src/Message-Groups-Guide.xml
qpid/trunk/qpid/doc/book/src/Using-message-groups.xml
Modified: qpid/trunk/qpid/doc/book/src/Message-Groups-Guide.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Message-Groups-Guide.xml?rev=1220953&r1=1220952&r2=1220953&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Message-Groups-Guide.xml (original)
+++ qpid/trunk/qpid/doc/book/src/Message-Groups-Guide.xml Mon Dec 19 21:21:34 2011
@@ -41,25 +41,34 @@
<example>
<title>Message Group Queue Creation - Python</title>
<programlisting lang="python">
- sender = connection.session().sender("msg-group-q; {create:always, delete:receiver," +
- " node: {x-declare: {arguments:" +
- " {'qpid.group_header_key':'THE-GROUP'," +
- "'qpid.shared_msg_group':1}}}}")
+sender = connection.session().sender("msg-group-q;" +
+ " {create:always, delete:receiver," +
+ " node: {x-declare: {arguments:" +
+ " {'qpid.group_header_key':'THE-GROUP'," +
+ " 'qpid.shared_msg_group':1}}}}")
</programlisting>
</example>
<example>
<title>Message Group Queue Creation - C++</title>
<programlisting lang="c++">
- std::string addr("msg-group-q; {create:always, delete:receiver, node: {x-declare: {arguments: {qpid.group_header_key:'THE-GROUP',qpid.shared_msg_group:1}}}}");
- Sender sender = session.createSender(addr);
+std::string addr("msg-group-q; "
+ " {create:always, delete:receiver,"
+ " node: {x-declare: {arguments:"
+ " {qpid.group_header_key:'THE-GROUP',"
+ " qpid.shared_msg_group:1}}}}");
+Sender sender = session.createSender(addr);
</programlisting>
</example>
<example>
<title>Message Group Queue Creation - Java</title>
<programlisting lang="java">
- Session s = c.createSession(false, Session.CLIENT_ACKNOWLEDGE);
- Destination d = (Destination) new AMQAnyDestination("msg-group-q; {create:always, delete:receiver, node: {x-declare: {arguments: {'qpid.group_header_key':'THE-GROUP','qpid.shared_msg_group':1}}}}");
- MessageProducer sender = s.createProducer(d);
+Session s = c.createSession(false, Session.CLIENT_ACKNOWLEDGE);
+String addr = "msg-group-q; {create:always, delete:receiver," +
+ " node: {x-declare: {arguments:" +
+ " {'qpid.group_header_key':'THE-GROUP'," +
+ " 'qpid.shared_msg_group':1}}}}";
+Destination d = (Destination) new AMQAnyDestination(addr);
+MessageProducer sender = s.createProducer(d);
</programlisting>
</example>
<para>
@@ -80,57 +89,57 @@
<example>
<title>Sending Grouped Messages - Python</title>
<programlisting lang="python">
- group = "A"
- m = Message(content="some data", properties={"THE-GROUP": group})
- sender.send(m)
-
- group = "B"
- m = Message(content="some other group's data", properties={"THE-GROUP": group})
- sender.send(m)
-
- group = "A"
- m = Message(content="more data for group 'A'", properties={"THE-GROUP": group})
- sender.send(m)
+group = "A"
+m = Message(content="some data", properties={"THE-GROUP": group})
+sender.send(m)
+
+group = "B"
+m = Message(content="some other group's data", properties={"THE-GROUP": group})
+sender.send(m)
+
+group = "A"
+m = Message(content="more data for group 'A'", properties={"THE-GROUP": group})
+sender.send(m)
</programlisting>
</example>
<example>
<title>Sending Grouped Messages - C++</title>
<programlisting lang="C++">
- const std::string groupKey("THE-GROUP");
- {
- Message msg("some data");
- msg.getProperties()[groupKey] = std::string("A");
- sender.send(msg);
- }
- {
- Message msg("some other group's data");
- msg.getProperties()[groupKey] = std::string("B");
- sender.send(msg);
- }
- {
- Message msg("more data for group 'A'");
- msg.getProperties()[groupKey] = std::string("A");
- sender.send(msg);
- }
+const std::string groupKey("THE-GROUP");
+{
+ Message msg("some data");
+ msg.getProperties()[groupKey] = std::string("A");
+ sender.send(msg);
+}
+{
+ Message msg("some other group's data");
+ msg.getProperties()[groupKey] = std::string("B");
+ sender.send(msg);
+}
+{
+ Message msg("more data for group 'A'");
+ msg.getProperties()[groupKey] = std::string("A");
+ sender.send(msg);
+}
</programlisting>
</example>
<example>
<title>Sending Grouped Messages - Java</title>
<programlisting lang="java">
- String groupKey = "THE-GROUP";
+String groupKey = "THE-GROUP";
- TextMessage tmsg1 = s.createTextMessage("some data");
- tmsg1.setStringProperty(groupKey, "A");
- sender.send(tmsg1);
-
- TextMessage tmsg2 = s.createTextMessage("some other group's data");
- tmsg2.setStringProperty(groupKey, "B");
- sender.send(tmsg2);
-
- TextMessage tmsg3 = s.createTextMessage("more data for group 'A'");
- tmsg3.setStringProperty(groupKey, "A");
- sender.send(tmsg3);
+TextMessage tmsg1 = s.createTextMessage("some data");
+tmsg1.setStringProperty(groupKey, "A");
+sender.send(tmsg1);
+
+TextMessage tmsg2 = s.createTextMessage("some other group's data");
+tmsg2.setStringProperty(groupKey, "B");
+sender.send(tmsg2);
+
+TextMessage tmsg3 = s.createTextMessage("more data for group 'A'");
+tmsg3.setStringProperty(groupKey, "A");
+sender.send(tmsg3);
</programlisting>
</example>
<para>
Modified: qpid/trunk/qpid/doc/book/src/Using-message-groups.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Using-message-groups.xml?rev=1220953&r1=1220952&r2=1220953&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Using-message-groups.xml (original)
+++ qpid/trunk/qpid/doc/book/src/Using-message-groups.xml Mon Dec 19 21:21:34 2011
@@ -187,10 +187,28 @@
Message group support can be enabled on a queue using the
<command>qpid-config</command> command line tool. The following options should be
provided when adding a new queue:
- <programlisting>
- --group-header=<replaceable>header-name</replaceable> Enable message group support for this queue. Specify name of application header that holds the group identifier.
- --shared-groups Enforce ordered message group consumption across multiple consumers.
- </programlisting>
+ <table>
+ <title>qpid-config options for creating message group queues</title>
+ <tgroup cols="2">
+ <thead>
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <row>
+ <entry>Option</entry><entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>--group-header=<replaceable>header-name</replaceable></entry>
+ <entry>Enable message group support for this queue. Specify name of application header that holds the group identifier.</entry>
+ </row>
+ <row>
+ <entry>--shared-groups</entry>
+ <entry>Enforce ordered message group consumption across multiple consumers.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</para>
<para>
Message group support may also be specified in the
@@ -239,7 +257,7 @@
the key "GROUP_KEY".
</para>
<programlisting>
- qpid-config add queue MyMsgQueue --group-header="GROUP_KEY" --shared-groups"
+qpid-config add queue MyMsgQueue --group-header="GROUP_KEY" --shared-groups
</programlisting>
</example>
<example>
@@ -249,8 +267,11 @@
with the same configuration as the previous example.
</para>
<programlisting>
- sender = session.createSender("MyMsgQueue; {create:always, delete:receiver, node: {x-declare: {arguments:"
- " {'qpid.group_header_key':'GROUP_KEY', 'qpid.shared_msg_group':1}}}}")
+sender = session.createSender("MyMsgQueue;"
+ " {create:always, delete:receiver,"
+ " node: {x-declare: {arguments:"
+ " {'qpid.group_header_key':'GROUP_KEY',"
+ " 'qpid.shared_msg_group':1}}}}")
</programlisting>
</example>
<section role="h3" id="usingmessagegroups-DefaultGroup">
@@ -262,7 +283,7 @@
<example>
<title>Overriding the default message group identifier for the broker</title>
<programlisting>
- qpidd --default-msg-group "EMPTY-GROUP"
+qpidd --default-msg-group "EMPTY-GROUP"
</programlisting>
</example>
</para>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org