Class ConsumerFlowStrategy.CreditEveryNthChunkConsumerFlowStrategy

java.lang.Object

com.rabbitmq.stream.ConsumerFlowStrategy.CreditEveryNthChunkConsumerFlowStrategy

All Implemented Interfaces:

ConsumerFlowStrategy

Enclosing interface:

ConsumerFlowStrategy

public static final class ConsumerFlowStrategy.CreditEveryNthChunkConsumerFlowStrategy
extends Object
implements ConsumerFlowStrategy

Strategy that provides the specified number of initial credits and n credits every n chunks.

This strategy can improve throughput for some workloads, it is possible to experiment with it if hitting problems with other flow strategies.

The number of initial credits must be at least twice as big as n.

Calls to MessageHandler.Context.processed() are ignored.

Since:

0.12.0

Nested Class Summary

Nested classes/interfaces inherited from interface ConsumerFlowStrategy

ConsumerFlowStrategy.Context, ConsumerFlowStrategy.CreditEveryNthChunkConsumerFlowStrategy, ConsumerFlowStrategy.CreditOnChunkArrivalConsumerFlowStrategy, ConsumerFlowStrategy.MessageCountConsumerFlowStrategy, ConsumerFlowStrategy.MessageProcessedCallback

Method Summary

Modifier and Type	Method	Description
int	initialCredits()	The initial number of credits for a subscription.
ConsumerFlowStrategy.MessageProcessedCallback	start(ConsumerFlowStrategy.Context context)	Return the behavior for MessageHandler.Context.processed() calls.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

initialCredits

public int initialCredits()

Description copied from interface: ConsumerFlowStrategy

The initial number of credits for a subscription.

It must be greater than 0. Values are usually between 1 and 10.

Specified by:

initialCredits in interface ConsumerFlowStrategy

Returns:

initial number of credits

start

public ConsumerFlowStrategy.MessageProcessedCallback start(ConsumerFlowStrategy.Context context)

Description copied from interface: ConsumerFlowStrategy

Return the behavior for MessageHandler.Context.processed() calls.

This method is called for each chunk of messages. Implementations return a callback that will be called when applications consider a message dealt with and call MessageHandler.Context.processed(). The callback can count messages and provide credits accordingly.

Specified by:

start in interface ConsumerFlowStrategy

Parameters:

context - chunk context

Returns:

the message processed callback