diff options
| author | Robert Gemmell <robbie@apache.org> | 2010-12-05 19:05:15 +0000 |
|---|---|---|
| committer | Robert Gemmell <robbie@apache.org> | 2010-12-05 19:05:15 +0000 |
| commit | 8e8093296e136d3507fc5ced1f0d9329cb8d2ff5 (patch) | |
| tree | 95110f3531e454953d41dc5c0d65a222d408cadc | |
| parent | 41ec7082ed07d45b869fd3f75e2bcd9237999792 (diff) | |
| download | qpid-python-8e8093296e136d3507fc5ced1f0d9329cb8d2ff5.tar.gz | |
convert SCD guide from full book to a section to allow building the containing Java docs
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1042407 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml | 71 |
1 files changed, 34 insertions, 37 deletions
diff --git a/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml b/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml index d96ab14797..4d5bad73a3 100644 --- a/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml +++ b/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml @@ -21,13 +21,10 @@ under the License. --> -<book lang='en_US'> -<title>Slow Consumer Disconnect - User Guide</title> +<section> + <title>Slow Consumer Disconnect - User Guide</title> - <chapter> -<title> </title> - - <sect1> + <section> <title>Introduction</title> <para> @@ -64,10 +61,10 @@ </para> - </sect1> + </section> - <sect1> -<title><emphasis role='bold'>What can it do?</emphasis></title> + <section> +<title>What can it do?</title> <para> </para> @@ -90,15 +87,15 @@ </para> - </sect1> + </section> - <sect1> + <section> <title>Frequency of SCD Checking</title> <para> </para> - <sect2> + <section> <title><emphasis role='bold'>Configuring Frequency</emphasis></title> <para> @@ -147,9 +144,9 @@ </para> - </sect2> + </section> - <sect2> + <section> <title><emphasis role='bold'>SCD Log output</emphasis></title> <para> @@ -167,11 +164,11 @@ SCD-1003 : Checking Status of Queue </para> - </sect2> + </section> - </sect1> + </section> - <sect1> + <section> <title>Client Exception<emphasis role='bold'>s</emphasis></title> <para>When a Slow Consumer is disconnected, the client receives a 506 error from the broker wrapped in a JMSException and the Session and Connection are closed:</para> @@ -274,15 +271,15 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess </para> - </sect1> + </section> - <sect1> + <section> <title>Disconnection Thresholds</title> <para> </para> - <sect2> + <section> <title>Topic Subscriptions</title> <para>One key feature of SCD is the disconnection of a consuming client when a specified threshold is exceeded. For a pub-sub model using topics, this means that messages will no @@ -293,9 +290,9 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess </para> - </sect2> + </section> - <sect2> + <section> <title>Durable Topic Subscriptions</title> <para>For durable subscriptions, simply disconnecting the consuming client will not suffice since the associated queue is by definition durable and messages would continue to flow to @@ -311,17 +308,17 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess </para> - </sect2> + </section> - <sect2> + <section> <title>Message Age Threshold</title> <para>You can configure SCD to be triggered on a topic or subscription when the oldest message in the associated private queue for the consumer ages beyond the specified value, in milliseconds. </para> - </sect2> + </section> - <sect2> + <section> <title>Queue Depth Threshold</title> <para>You can opt to use the depth of the queue in bytes as a threshold. SCD will be triggered by a queue depth greater than the threshold specified i.e. when a broker receives a @@ -331,9 +328,9 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess </para> - </sect2> + </section> - <sect2> + <section> <title>Message Count Threshold</title> <para>You can use the message count for the consumer's queue as the trigger, where a count higher than that specified will trigger disconnection. </para> @@ -342,9 +339,9 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess </para> - </sect2> + </section> - <sect2> + <section> <title><emphasis role='bold'>Delete Policy</emphasis></title> <para>You can configure the policy you wish to apply in your broker configuration. There are currently 2 policies available: </para> @@ -432,12 +429,12 @@ The following steps are required to configure SCD: <para></topics> </para> - </sect2> + </section> - </sect1> + </section> - <sect1> -<title><emphasis role='bold'>Important Points To Note</emphasis></title> + <section> +<title>Important Points To Note</title> <para> Client application developers should be educated about how to correctly handle being disconnected with a 506 error code, to avoid them getting into a thrashing state where they continually attempt to connect, fail to consume fast enough and are disconnected again. </para> @@ -466,8 +463,8 @@ The following steps are required to configure SCD: </para> - </sect1> + </section> + + </section> - </chapter> -</book> |
