From 4547e57a10379bf329554aaa2e2353f8eb52da65 Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Sun, 5 Dec 2010 19:05:15 +0000 Subject: 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/qpid@1042407 13f79535-47bb-0310-9956-ffa450edef68 --- doc/book/src/How-to-Use-SlowConsumerDisconnect.xml | 71 +++++++++++----------- 1 file changed, 34 insertions(+), 37 deletions(-) diff --git a/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml b/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml index d96ab14797..4d5bad73a3 100644 --- a/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml +++ b/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml @@ -21,13 +21,10 @@ under the License. --> - -Slow Consumer Disconnect - User Guide +
+ Slow Consumer Disconnect - User Guide - - - - +
Introduction @@ -64,10 +61,10 @@ - +
- -<emphasis role='bold'>What can it do?</emphasis> +
+What can it do? @@ -90,15 +87,15 @@ - +
- +
Frequency of SCD Checking - +
<emphasis role='bold'>Configuring Frequency</emphasis> @@ -147,9 +144,9 @@ - +
- +
<emphasis role='bold'>SCD Log output</emphasis> @@ -167,11 +164,11 @@ SCD-1003 : Checking Status of Queue - +
- +
- +
Client Exception<emphasis role='bold'>s</emphasis> 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: @@ -274,15 +271,15 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess - +
- +
Disconnection Thresholds - +
Topic Subscriptions 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 - +
- +
Durable Topic Subscriptions 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 - +
- +
Message Age Threshold 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. - +
- +
Queue Depth Threshold 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 - +
- +
Message Count Threshold You can use the message count for the consumer's queue as the trigger, where a count higher than that specified will trigger disconnection. @@ -342,9 +339,9 @@ main 2010-09-01 16:23:34,316 INFO /[apache.qpid.client.AMQSession/] Closing sess - +
- +
<emphasis role='bold'>Delete Policy</emphasis> You can configure the policy you wish to apply in your broker configuration. There are currently 2 policies available: @@ -432,12 +429,12 @@ The following steps are required to configure SCD: </topics> - +
- +
- -<emphasis role='bold'>Important Points To Note</emphasis> +
+Important Points To Note 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. @@ -466,8 +463,8 @@ The following steps are required to configure SCD: - +
+ +
- - -- cgit v1.2.1