Merge pull request #46 from shafreenAnfar/consumer-all
Add consume one message at a time feature
diff --git a/modules/documentation/src/site/xdoc/userguide/samples/sample705.xml b/modules/documentation/src/site/xdoc/userguide/samples/sample705.xml
index cc37241..3b90a24 100644
--- a/modules/documentation/src/site/xdoc/userguide/samples/sample705.xml
+++ b/modules/documentation/src/site/xdoc/userguide/samples/sample705.xml
@@ -59,6 +59,7 @@
<parameter name="max.deliver.drop">true</parameter>
<parameter name="retry.http.status.codes">500, 504</parameter>
<parameter name="retry.interval">1000</parameter>
+ <parameter name="consume.all">false</parameter>
</messageProcessor>
</definitions>
</div>
@@ -116,6 +117,14 @@
parameter. Similar to "interval" "retry.interval" value must be set in milli seconds. In the case of setting
a non-integer value, makes Message Forwarding Processor set the default value to "retry.interval", which is 1000ms.
</p>
+ <p>
+ Every time the Message Forwarding Processor is triggered it consumes all the messages in the Message Store at once. For instance,
+ suppose, the Message Forwarding Processor is configured to run every ten seconds and the Message Store is filled
+ with five messages within the ten second gap. In such a situation, Message Forwarding Processor consumes all five messages
+ and try to send it to back-end as fast as possible. However, there could be situations where you need to send messages
+ to the back-end in a controlled rate. This can be achieved by setting the "consume.all" property value to false. When set to false,
+ the Message Forwarding Processor will only consume one message at each trigger.
+ </p>
</subsection>
</section>
<p>
