Package org.apache.pulsar.broker.service.persistent

Class PersistentDispatcherMultipleConsumers

java.lang.Object

org.apache.pulsar.broker.service.EntryFilterSupport

org.apache.pulsar.broker.service.AbstractBaseDispatcher

org.apache.pulsar.broker.service.AbstractDispatcherMultipleConsumers

org.apache.pulsar.broker.service.persistent.PersistentDispatcherMultipleConsumers

All Implemented Interfaces:

org.apache.bookkeeper.mledger.AsyncCallbacks.ReadEntriesCallback, Dispatcher

Direct Known Subclasses:

PersistentStickyKeyDispatcherMultipleConsumers, PersistentStreamingDispatcherMultipleConsumers

public class PersistentDispatcherMultipleConsumers
extends AbstractDispatcherMultipleConsumers
implements Dispatcher, org.apache.bookkeeper.mledger.AsyncCallbacks.ReadEntriesCallback

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	PersistentDispatcherMultipleConsumers.ReadType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final AtomicIntegerFieldUpdater<PersistentDispatcherMultipleConsumers>	BLOCKED_DISPATCHER_ON_UNACKMSG_UPDATER
protected final org.apache.bookkeeper.mledger.ManagedCursor	cursor
protected final ExecutorService	dispatchMessagesThread
protected Optional<DispatchRateLimiter>	dispatchRateLimiter
protected boolean	havePendingRead
protected boolean	havePendingReplayRead
protected com.google.common.collect.Range<org.apache.bookkeeper.mledger.impl.PositionImpl>	lastIndividualDeletedRangeFromCursorRecovery
protected org.apache.bookkeeper.mledger.impl.PositionImpl	minReplayedPosition
protected final String	name
protected int	readBatchSize
protected final org.apache.pulsar.client.impl.Backoff	readFailureBackoff
protected final MessageRedeliveryController	redeliveryMessages
protected final RedeliveryTracker	redeliveryTracker
protected boolean	sendInProgress
protected boolean	shouldRewindBeforeReadingOrReplaying
protected final PersistentTopic	topic
protected static final AtomicIntegerFieldUpdater<PersistentDispatcherMultipleConsumers>	TOTAL_AVAILABLE_PERMITS_UPDATER
protected int	totalAvailablePermits
protected int	totalUnackedMessages

Fields inherited from class org.apache.pulsar.broker.service.AbstractDispatcherMultipleConsumers

consumerList, consumerSet, currentConsumerRoundRobinIndex, FALSE, IS_CLOSED_UPDATER, TRUE

Fields inherited from class org.apache.pulsar.broker.service.AbstractBaseDispatcher

dispatchThrottlingOnBatchMessageEnabled, serviceConfig

Fields inherited from class org.apache.pulsar.broker.service.EntryFilterSupport

entryFilters, filterContext, subscription

Constructor Summary

Constructors

Constructor	Description
PersistentDispatcherMultipleConsumers(PersistentTopic topic, org.apache.bookkeeper.mledger.ManagedCursor cursor, Subscription subscription)
PersistentDispatcherMultipleConsumers(PersistentTopic topic, org.apache.bookkeeper.mledger.ManagedCursor cursor, Subscription subscription, boolean allowOutOfOrderDelivery)

Method Summary

Modifier and Type	Method	Description
void	addConsumer(Consumer consumer)
protected boolean	addMessageToReplay(long ledgerId, long entryId)
protected boolean	addMessageToReplay(long ledgerId, long entryId, long stickyKeyHash)
void	addUnAckedMessages(int numberOfMessages)
protected Set<? extends org.apache.bookkeeper.mledger.Position>	asyncReplayEntries(Set<? extends org.apache.bookkeeper.mledger.Position> positions)
protected Set<? extends org.apache.bookkeeper.mledger.Position>	asyncReplayEntriesInOrder(Set<? extends org.apache.bookkeeper.mledger.Position> positions)
void	blockDispatcherOnUnackedMsgs()
protected org.apache.commons.lang3.tuple.Pair<Integer,Long>	calculateToRead(int currentTotalAvailablePermits)
protected void	cancelPendingRead()
boolean	canUnsubscribe(Consumer consumer)
boolean	checkAndUnblockIfStuck()	Checks if dispatcher is stuck and unblocks the dispatch if needed.
void	clearDelayedMessages()
CompletableFuture<Void>	close()	mark dispatcher closed to stop new incoming requests and disconnect all consumers.
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)	Indicates that this consumer is now ready to receive more messages.
void	cursorIsReset()
CompletableFuture<Void>	disconnectActiveConsumers(boolean isResetCursor)	Disconnect active consumers.
CompletableFuture<Void>	disconnectAllConsumers(boolean isResetCursor)	disconnect all consumers.
CopyOnWriteArrayList<Consumer>	getConsumers()
long	getDelayedTrackerMemoryUsage()
protected int	getFirstAvailableConsumerPermits()
protected Set<org.apache.bookkeeper.mledger.impl.PositionImpl>	getMessagesToReplayNow(int maxMessagesToRead)
String	getName()
long	getNumberOfDelayedMessages()
Optional<DispatchRateLimiter>	getRateLimiter()
RedeliveryTracker	getRedeliveryTracker()
protected int	getStickyKeyHash(org.apache.bookkeeper.mledger.Entry entry)
PersistentTopic	getTopic()
int	getTotalUnackedMessages()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
boolean	initializeDispatchRateLimiterIfNeeded()
protected boolean	isAtleastOneConsumerAvailable()	returns true only if AbstractDispatcherMultipleConsumers.consumerList has atleast one unblocked consumer and have available permits.
boolean	isBlockedDispatcherOnUnackedMsgs()
boolean	isConsumerAvailable(Consumer consumer)
boolean	isConsumerConnected()
protected boolean	isConsumersExceededOnSubscription()	Determine whether the number of consumers on the subscription reaches the threshold.
final void	readEntriesComplete(List<org.apache.bookkeeper.mledger.Entry> entries, Object ctx)
void	readEntriesFailed(org.apache.bookkeeper.mledger.ManagedLedgerException exception, Object ctx)
void	readMoreEntries()
void	readMoreEntriesAsync()	We should not call readMoreEntries() recursively in the same thread as there is a risk of StackOverflowError.
void	redeliverUnacknowledgedMessages(Consumer consumer, long consumerEpoch)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<org.apache.bookkeeper.mledger.impl.PositionImpl> positions)
void	removeConsumer(Consumer consumer)
protected void	reScheduleRead()
void	reset()	mark dispatcher open to serve new incoming requests.
void	resetCloseFuture()
protected final boolean	sendMessagesToConsumers(PersistentDispatcherMultipleConsumers.ReadType readType, List<org.apache.bookkeeper.mledger.Entry> entries)
protected boolean	shouldPauseDeliveryForDelayTracker()
boolean	trackDelayedDelivery(long ledgerId, long entryId, org.apache.pulsar.common.api.proto.MessageMetadata msgMetadata)	Check with dispatcher if the message should be added to the delayed delivery tracker.
protected boolean	trySendMessagesToConsumers(PersistentDispatcherMultipleConsumers.ReadType readType, List<org.apache.bookkeeper.mledger.Entry> entries)	Dispatch the messages to the Consumers.
void	unBlockDispatcherOnUnackedMsgs()
void	updateRateLimiter()

Methods inherited from class org.apache.pulsar.broker.service.AbstractDispatcherMultipleConsumers

getNextConsumer, getRandomConsumer, isClosed

Methods inherited from class org.apache.pulsar.broker.service.AbstractBaseDispatcher

computeReadLimits, filterEntriesForConsumer, filterEntriesForConsumer, getFilterAcceptedMsgCount, getFilterProcessedMsgCount, getFilterRejectedMsgCount, getFilterRescheduledMsgCount, getSubscriptionName, isConsumersExceededOnSubscription, peekStickyKey, reachDispatchRateLimit, updateMessagesToRead, updatePendingBytesToDispatch

Methods inherited from class org.apache.pulsar.broker.service.EntryFilterSupport

runFiltersForEntry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.broker.service.Dispatcher

disconnectAllConsumers, getFilterAcceptedMsgCount, getFilterProcessedMsgCount, getFilterRejectedMsgCount, getFilterRescheduledMsgCount, isClosed, markDeletePositionMoveForward

Field Details

topic

protected final PersistentTopic topic

cursor

protected final org.apache.bookkeeper.mledger.ManagedCursor cursor

lastIndividualDeletedRangeFromCursorRecovery

protected volatile com.google.common.collect.Range<org.apache.bookkeeper.mledger.impl.PositionImpl> lastIndividualDeletedRangeFromCursorRecovery

redeliveryMessages

protected final MessageRedeliveryController redeliveryMessages

redeliveryTracker

protected final RedeliveryTracker redeliveryTracker

havePendingRead

protected volatile boolean havePendingRead

havePendingReplayRead

protected volatile boolean havePendingReplayRead

minReplayedPosition

protected volatile org.apache.bookkeeper.mledger.impl.PositionImpl minReplayedPosition

shouldRewindBeforeReadingOrReplaying

protected boolean shouldRewindBeforeReadingOrReplaying

name

protected final String name

sendInProgress

protected boolean sendInProgress

TOTAL_AVAILABLE_PERMITS_UPDATER

protected static final AtomicIntegerFieldUpdater<PersistentDispatcherMultipleConsumers> TOTAL_AVAILABLE_PERMITS_UPDATER

totalAvailablePermits

protected volatile int totalAvailablePermits

readBatchSize

protected volatile int readBatchSize

readFailureBackoff

protected final org.apache.pulsar.client.impl.Backoff readFailureBackoff

totalUnackedMessages

protected volatile int totalUnackedMessages

BLOCKED_DISPATCHER_ON_UNACKMSG_UPDATER

protected static final AtomicIntegerFieldUpdater<PersistentDispatcherMultipleConsumers> BLOCKED_DISPATCHER_ON_UNACKMSG_UPDATER

dispatchRateLimiter

protected Optional<DispatchRateLimiter> dispatchRateLimiter

dispatchMessagesThread

protected final ExecutorService dispatchMessagesThread

Constructor Details

PersistentDispatcherMultipleConsumers

public PersistentDispatcherMultipleConsumers(PersistentTopic topic,
 org.apache.bookkeeper.mledger.ManagedCursor cursor,
 Subscription subscription)

PersistentDispatcherMultipleConsumers

public PersistentDispatcherMultipleConsumers(PersistentTopic topic,
 org.apache.bookkeeper.mledger.ManagedCursor cursor,
 Subscription subscription,
 boolean allowOutOfOrderDelivery)

Method Details

addConsumer

public void addConsumer(Consumer consumer)
                 throws BrokerServiceException

Specified by:

addConsumer in interface Dispatcher

Throws:

BrokerServiceException

isConsumersExceededOnSubscription

protected boolean isConsumersExceededOnSubscription()

Description copied from class: AbstractBaseDispatcher

Determine whether the number of consumers on the subscription reaches the threshold.

Specified by:

isConsumersExceededOnSubscription in class AbstractBaseDispatcher

Returns:

removeConsumer

public void removeConsumer(Consumer consumer)
                    throws BrokerServiceException

Specified by:

removeConsumer in interface Dispatcher

Throws:

BrokerServiceException

consumerFlow

public void consumerFlow(Consumer consumer,
 int additionalNumberOfMessages)

Description copied from interface: Dispatcher

Indicates that this consumer is now ready to receive more messages.

Specified by:

consumerFlow in interface Dispatcher

readMoreEntriesAsync

public void readMoreEntriesAsync()

We should not call readMoreEntries() recursively in the same thread as there is a risk of StackOverflowError.

readMoreEntries

public void readMoreEntries()

reScheduleRead

protected void reScheduleRead()

Specified by:

reScheduleRead in class AbstractBaseDispatcher

calculateToRead

protected org.apache.commons.lang3.tuple.Pair<Integer,Long> calculateToRead(int currentTotalAvailablePermits)

asyncReplayEntries

protected Set<? extends org.apache.bookkeeper.mledger.Position> asyncReplayEntries(Set<? extends org.apache.bookkeeper.mledger.Position> positions)

asyncReplayEntriesInOrder

protected Set<? extends org.apache.bookkeeper.mledger.Position> asyncReplayEntriesInOrder(Set<? extends org.apache.bookkeeper.mledger.Position> positions)

isConsumerConnected

public boolean isConsumerConnected()

Specified by:

isConsumerConnected in interface Dispatcher

Overrides:

isConsumerConnected in class AbstractDispatcherMultipleConsumers

getConsumers

public CopyOnWriteArrayList<Consumer> getConsumers()

Specified by:

getConsumers in interface Dispatcher

Overrides:

getConsumers in class AbstractDispatcherMultipleConsumers

canUnsubscribe

public boolean canUnsubscribe(Consumer consumer)

Specified by:

canUnsubscribe in interface Dispatcher

Overrides:

canUnsubscribe in class AbstractDispatcherMultipleConsumers

close

public CompletableFuture<Void> close()

Description copied from interface: Dispatcher

mark dispatcher closed to stop new incoming requests and disconnect all consumers.

Specified by:

close in interface Dispatcher

Returns:

disconnectAllConsumers

public CompletableFuture<Void> disconnectAllConsumers(boolean isResetCursor)

Description copied from interface: Dispatcher

disconnect all consumers.

Specified by:

disconnectAllConsumers in interface Dispatcher

Returns:

cancelPendingRead

protected void cancelPendingRead()

Overrides:

cancelPendingRead in class AbstractDispatcherMultipleConsumers

disconnectActiveConsumers

public CompletableFuture<Void> disconnectActiveConsumers(boolean isResetCursor)

Description copied from interface: Dispatcher

Disconnect active consumers.

Specified by:

disconnectActiveConsumers in interface Dispatcher

resetCloseFuture

public void resetCloseFuture()

Specified by:

resetCloseFuture in interface Dispatcher

Overrides:

resetCloseFuture in class AbstractBaseDispatcher

reset

public void reset()

Description copied from interface: Dispatcher

mark dispatcher open to serve new incoming requests.

Specified by:

reset in interface Dispatcher

getType

public org.apache.pulsar.common.api.proto.CommandSubscribe.SubType getType()

Specified by:

getType in interface Dispatcher

Overrides:

getType in class AbstractDispatcherMultipleConsumers

readEntriesComplete

public final void readEntriesComplete(List<org.apache.bookkeeper.mledger.Entry> entries,
 Object ctx)

Specified by:

readEntriesComplete in interface org.apache.bookkeeper.mledger.AsyncCallbacks.ReadEntriesCallback

sendMessagesToConsumers

protected final boolean sendMessagesToConsumers(PersistentDispatcherMultipleConsumers.ReadType readType,
 List<org.apache.bookkeeper.mledger.Entry> entries)

trySendMessagesToConsumers

protected boolean trySendMessagesToConsumers(PersistentDispatcherMultipleConsumers.ReadType readType,
 List<org.apache.bookkeeper.mledger.Entry> entries)

Dispatch the messages to the Consumers.

Returns:

true if you want to trigger a new read. This method is overridden by other classes, please take a look to other implementations if you need to change it.

readEntriesFailed

public void readEntriesFailed(org.apache.bookkeeper.mledger.ManagedLedgerException exception,
 Object ctx)

Specified by:

readEntriesFailed in interface org.apache.bookkeeper.mledger.AsyncCallbacks.ReadEntriesCallback

isAtleastOneConsumerAvailable

protected boolean isAtleastOneConsumerAvailable()

returns true only if AbstractDispatcherMultipleConsumers.consumerList has atleast one unblocked consumer and have available permits.

Returns:

getFirstAvailableConsumerPermits

protected int getFirstAvailableConsumerPermits()

isConsumerAvailable

public boolean isConsumerAvailable(Consumer consumer)

Specified by:

isConsumerAvailable in class AbstractDispatcherMultipleConsumers

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Consumer consumer,
 long consumerEpoch)

Specified by:

redeliverUnacknowledgedMessages in interface Dispatcher

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Consumer consumer,
 List<org.apache.bookkeeper.mledger.impl.PositionImpl> positions)

Specified by:

redeliverUnacknowledgedMessages in interface Dispatcher

addUnAckedMessages

public void addUnAckedMessages(int numberOfMessages)

Specified by:

addUnAckedMessages in interface Dispatcher

isBlockedDispatcherOnUnackedMsgs

public boolean isBlockedDispatcherOnUnackedMsgs()

blockDispatcherOnUnackedMsgs

public void blockDispatcherOnUnackedMsgs()

unBlockDispatcherOnUnackedMsgs

public void unBlockDispatcherOnUnackedMsgs()

getTotalUnackedMessages

public int getTotalUnackedMessages()

getName

public String getName()

getRedeliveryTracker

public RedeliveryTracker getRedeliveryTracker()

Specified by:

getRedeliveryTracker in interface Dispatcher

getRateLimiter

public Optional<DispatchRateLimiter> getRateLimiter()

Specified by:

getRateLimiter in interface Dispatcher

updateRateLimiter

public void updateRateLimiter()

Specified by:

updateRateLimiter in interface Dispatcher

initializeDispatchRateLimiterIfNeeded

public boolean initializeDispatchRateLimiterIfNeeded()

Specified by:

initializeDispatchRateLimiterIfNeeded in interface Dispatcher

trackDelayedDelivery

public boolean trackDelayedDelivery(long ledgerId,
 long entryId,
 org.apache.pulsar.common.api.proto.MessageMetadata msgMetadata)

Description copied from interface: Dispatcher

Check with dispatcher if the message should be added to the delayed delivery tracker. Return true if the message should be delayed and ignored at this point.

Specified by:

trackDelayedDelivery in interface Dispatcher

getMessagesToReplayNow

protected Set<org.apache.bookkeeper.mledger.impl.PositionImpl> getMessagesToReplayNow(int maxMessagesToRead)

shouldPauseDeliveryForDelayTracker

protected boolean shouldPauseDeliveryForDelayTracker()

getNumberOfDelayedMessages

public long getNumberOfDelayedMessages()

Specified by:

getNumberOfDelayedMessages in interface Dispatcher

clearDelayedMessages

public void clearDelayedMessages()

Specified by:

clearDelayedMessages in interface Dispatcher

cursorIsReset

public void cursorIsReset()

Specified by:

cursorIsReset in interface Dispatcher

addMessageToReplay

protected boolean addMessageToReplay(long ledgerId,
 long entryId,
 long stickyKeyHash)

addMessageToReplay

protected boolean addMessageToReplay(long ledgerId,
 long entryId)

checkAndUnblockIfStuck

public boolean checkAndUnblockIfStuck()

Description copied from interface: Dispatcher

Checks if dispatcher is stuck and unblocks the dispatch if needed.

Specified by:

checkAndUnblockIfStuck in interface Dispatcher

getTopic

public PersistentTopic getTopic()

getDelayedTrackerMemoryUsage

public long getDelayedTrackerMemoryUsage()

getStickyKeyHash

protected int getStickyKeyHash(org.apache.bookkeeper.mledger.Entry entry)