diff options
| author | Kenneth Anthony Giusti <kgiusti@apache.org> | 2011-12-19 21:21:34 +0000 |
|---|---|---|
| committer | Kenneth Anthony Giusti <kgiusti@apache.org> | 2011-12-19 21:21:34 +0000 |
| commit | 262d7e0328a5f559c4207c04da498a7b77d5a211 (patch) | |
| tree | c0bb8aceb2f12a0428a3c78dfd0dbfc78be3a09a | |
| parent | fb08688252d1043b202e1b88a9cd5b37da67794c (diff) | |
| download | qpid-python-262d7e0328a5f559c4207c04da498a7b77d5a211.tar.gz | |
NO-JIRA: reformat examples in the docs to fit in PDF output.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1220953 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | doc/book/src/Message-Groups-Guide.xml | 97 | ||||
| -rw-r--r-- | doc/book/src/Using-message-groups.xml | 37 |
2 files changed, 82 insertions, 52 deletions
diff --git a/doc/book/src/Message-Groups-Guide.xml b/doc/book/src/Message-Groups-Guide.xml index 2824816ba0..3e5c549ff9 100644 --- a/doc/book/src/Message-Groups-Guide.xml +++ b/doc/book/src/Message-Groups-Guide.xml @@ -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 = "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 = "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="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 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 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 tmsg3 = s.createTextMessage("more data for group 'A'"); +tmsg3.setStringProperty(groupKey, "A"); +sender.send(tmsg3); </programlisting> </example> <para> diff --git a/doc/book/src/Using-message-groups.xml b/doc/book/src/Using-message-groups.xml index 13d3f40a0b..9b904d9f18 100644 --- a/doc/book/src/Using-message-groups.xml +++ b/doc/book/src/Using-message-groups.xml @@ -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> |
