Package org.apache.pulsar.broker.service

Interface Dispatcher

All Known Subinterfaces:

NonPersistentDispatcher, StickyKeyDispatcher

All Known Implementing Classes:

AbstractBaseDispatcher, AbstractDispatcherMultipleConsumers, AbstractDispatcherSingleActiveConsumer, AbstractPersistentDispatcherMultipleConsumers, NonPersistentDispatcherMultipleConsumers, NonPersistentDispatcherSingleActiveConsumer, NonPersistentStickyKeyDispatcherMultipleConsumers, PersistentDispatcherMultipleConsumers, PersistentDispatcherMultipleConsumersClassic, PersistentDispatcherSingleActiveConsumer, PersistentStickyKeyDispatcherMultipleConsumers, PersistentStickyKeyDispatcherMultipleConsumersClassic

public interface Dispatcher

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addConsumer(Consumer consumer)
void	addUnAckedMessages(int unAckMessages)
default void	afterAckMessages(Throwable exOfDeletion, Object ctxOfDeletion)	A callback hook after acknowledge messages.
boolean	canUnsubscribe(Consumer consumer)
default boolean	checkAndResumeIfPaused()	Trigger a new "readMoreEntries" if the dispatching has been paused before.
default boolean	checkAndUnblockIfStuck()	Checks if dispatcher is stuck and unblocks the dispatch if needed.
default CompletableFuture<Void>	clearDelayedMessages()
default CompletableFuture<Void>	close()	mark dispatcher closed to stop new incoming requests and disconnect all consumers.
CompletableFuture<Void>	close(boolean disconnectClients, Optional<BrokerLookupData> assignedBrokerLookupData)
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)	Indicates that this consumer is now ready to receive more messages.
default void	cursorIsReset()
CompletableFuture<Void>	disconnectActiveConsumers(boolean isResetCursor)	Disconnect active consumers.
default CompletableFuture<Void>	disconnectAllConsumers()
default CompletableFuture<Void>	disconnectAllConsumers(boolean isResetCursor)	disconnect all consumers.
CompletableFuture<Void>	disconnectAllConsumers(boolean isResetCursor, Optional<BrokerLookupData> assignedBrokerLookupData)
List<Consumer>	getConsumers()
default long	getFilterAcceptedMsgCount()
default long	getFilterProcessedMsgCount()
default long	getFilterRejectedMsgCount()
default long	getFilterRescheduledMsgCount()
default long	getNumberOfDelayedMessages()
default Optional<DispatchRateLimiter>	getRateLimiter()
RedeliveryTracker	getRedeliveryTracker()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
default boolean	initializeDispatchRateLimiterIfNeeded()
boolean	isClosed()
boolean	isConsumerConnected()
default void	markDeletePositionMoveForward()
void	redeliverUnacknowledgedMessages(Consumer consumer, long consumerEpoch)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<Position> positions)
void	removeConsumer(Consumer consumer)
void	reset()	mark dispatcher open to serve new incoming requests.
void	resetCloseFuture()
default 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.
default void	updateRateLimiter()

Method Details

addConsumer

CompletableFuture<Void> addConsumer(Consumer consumer)

removeConsumer

void removeConsumer(Consumer consumer)
             throws BrokerServiceException

Throws:

BrokerServiceException

consumerFlow

void consumerFlow(Consumer consumer,
 int additionalNumberOfMessages)

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

Parameters:

consumer -

isConsumerConnected

boolean isConsumerConnected()

getConsumers

List<Consumer> getConsumers()

canUnsubscribe

boolean canUnsubscribe(Consumer consumer)

close

default CompletableFuture<Void> close()

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

Returns:

close

CompletableFuture<Void> close(boolean disconnectClients,
 Optional<BrokerLookupData> assignedBrokerLookupData)

isClosed

boolean isClosed()

disconnectActiveConsumers

CompletableFuture<Void> disconnectActiveConsumers(boolean isResetCursor)

Disconnect active consumers.

disconnectAllConsumers

default CompletableFuture<Void> disconnectAllConsumers(boolean isResetCursor)

disconnect all consumers.

Returns:

disconnectAllConsumers

default CompletableFuture<Void> disconnectAllConsumers()

disconnectAllConsumers

CompletableFuture<Void> disconnectAllConsumers(boolean isResetCursor,
 Optional<BrokerLookupData> assignedBrokerLookupData)

resetCloseFuture

void resetCloseFuture()

reset

void reset()

mark dispatcher open to serve new incoming requests.

getType

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

redeliverUnacknowledgedMessages

void redeliverUnacknowledgedMessages(Consumer consumer,
 long consumerEpoch)

redeliverUnacknowledgedMessages

void redeliverUnacknowledgedMessages(Consumer consumer,
 List<Position> positions)

addUnAckedMessages

void addUnAckedMessages(int unAckMessages)

getRedeliveryTracker

RedeliveryTracker getRedeliveryTracker()

getRateLimiter

default Optional<DispatchRateLimiter> getRateLimiter()

updateRateLimiter

default void updateRateLimiter()

initializeDispatchRateLimiterIfNeeded

default boolean initializeDispatchRateLimiterIfNeeded()

trackDelayedDelivery

default 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. Return true if the message should be delayed and ignored at this point.

getNumberOfDelayedMessages

default long getNumberOfDelayedMessages()

clearDelayedMessages

default CompletableFuture<Void> clearDelayedMessages()

cursorIsReset

default void cursorIsReset()

markDeletePositionMoveForward

default void markDeletePositionMoveForward()

checkAndUnblockIfStuck

default boolean checkAndUnblockIfStuck()

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

afterAckMessages

default void afterAckMessages(Throwable exOfDeletion,
 Object ctxOfDeletion)

A callback hook after acknowledge messages.

Parameters:

exOfDeletion - the ex of ManagedCursor.asyncDelete(org.apache.bookkeeper.mledger.Position, org.apache.bookkeeper.mledger.AsyncCallbacks.DeleteCallback, java.lang.Object), ManagedCursor.asyncClearBacklog(org.apache.bookkeeper.mledger.AsyncCallbacks.ClearBacklogCallback, java.lang.Object) or {@link ManagedCursor#asyncSkipEntries)}.

ctxOfDeletion - the param ctx of calling ManagedCursor.asyncDelete(org.apache.bookkeeper.mledger.Position, org.apache.bookkeeper.mledger.AsyncCallbacks.DeleteCallback, java.lang.Object), ManagedCursor.asyncClearBacklog(org.apache.bookkeeper.mledger.AsyncCallbacks.ClearBacklogCallback, java.lang.Object) or {@link ManagedCursor#asyncSkipEntries)}.

checkAndResumeIfPaused

default boolean checkAndResumeIfPaused()

Trigger a new "readMoreEntries" if the dispatching has been paused before. This method is only implemented in AbstractPersistentDispatcherMultipleConsumers right now, other implementations do not necessary implement this method.

Returns:

did a resume.

getFilterProcessedMsgCount

default long getFilterProcessedMsgCount()

getFilterAcceptedMsgCount

default long getFilterAcceptedMsgCount()

getFilterRejectedMsgCount

default long getFilterRejectedMsgCount()

getFilterRescheduledMsgCount

default long getFilterRescheduledMsgCount()