Package org.apache.pulsar.broker.service

Class AbstractDispatcherSingleActiveConsumer

java.lang.Object

org.apache.pulsar.broker.service.EntryFilterSupport

org.apache.pulsar.broker.service.AbstractBaseDispatcher

org.apache.pulsar.broker.service.AbstractDispatcherSingleActiveConsumer

All Implemented Interfaces:

Dispatcher

Direct Known Subclasses:

NonPersistentDispatcherSingleActiveConsumer, PersistentDispatcherSingleActiveConsumer

public abstract class AbstractDispatcherSingleActiveConsumer
extends AbstractBaseDispatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected CompletableFuture<Void>	closeFuture
protected final CopyOnWriteArrayList<Consumer>	consumers
protected final ManagedCursor	cursor
protected static final int	FALSE
protected static final AtomicIntegerFieldUpdater<AbstractDispatcherSingleActiveConsumer>	IS_CLOSED_UPDATER
protected boolean	isFirstRead
protected boolean	isKeyHashRangeFiltered
protected final int	partitionIndex
protected StickyKeyConsumerSelector	stickyKeyConsumerSelector
protected final org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	subscriptionType
protected final String	topicName
protected static final int	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, hasFilter, subscription

Constructor Summary

Constructors

Constructor	Description
AbstractDispatcherSingleActiveConsumer(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subscriptionType, int partitionIndex, String topicName, Subscription subscription, ServiceConfiguration serviceConfig, ManagedCursor cursor)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addConsumer(Consumer consumer)
protected abstract void	cancelPendingRead()
boolean	canUnsubscribe(Consumer consumer)	Handle unsubscribe command from the client API For failover subscription, if consumer is connected consumer, we can unsubscribe.
CompletableFuture<Void>	close(boolean disconnectConsumers, Optional<BrokerLookupData> assignedBrokerLookupData)
CompletableFuture<Void>	disconnectActiveConsumers(boolean isResetCursor)	Disconnect active consumers.
CompletableFuture<Void>	disconnectAllConsumers(boolean isResetCursor, Optional<BrokerLookupData> assignedBrokerLookupData)	Disconnect all consumers on this dispatcher (server side close).
Consumer	getActiveConsumer()
List<Consumer>	getConsumers()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
boolean	isClosed()
boolean	isConsumerConnected()
protected void	notifyActiveConsumerChanged(Consumer activeConsumer)
protected boolean	pickAndScheduleActiveConsumer()	Pick active consumer for a topic for CommandSubscribe.SubType.Failover subscription.
void	removeConsumer(Consumer consumer)
void	reset()	mark dispatcher open to serve new incoming requests.
void	resetCloseFuture()
protected abstract void	scheduleReadOnActiveConsumer()

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

acquirePermitsForDeliveredMessages, checkAndApplyReachedEndOfTopicOrTopicMigration, checkAndApplyReachedEndOfTopicOrTopicMigration, computeReadLimits, filterEntriesForConsumer, filterEntriesForConsumer, getFilterAcceptedMsgCount, getFilterProcessedMsgCount, getFilterRejectedMsgCount, getFilterRescheduledMsgCount, getSubscriptionName, isConsumersExceededOnSubscription, isConsumersExceededOnSubscription, peekStickyKey, reScheduleRead, 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

addUnAckedMessages, afterAckMessages, checkAndResumeIfPaused, checkAndUnblockIfStuck, clearDelayedMessages, close, consumerFlow, cursorIsReset, disconnectAllConsumers, disconnectAllConsumers, getNumberOfDelayedMessages, getRateLimiter, getRedeliveryTracker, initializeDispatchRateLimiterIfNeeded, markDeletePositionMoveForward, redeliverUnacknowledgedMessages, redeliverUnacknowledgedMessages, trackDelayedDelivery, updateRateLimiter

Field Details

topicName

protected final String topicName

consumers

protected final CopyOnWriteArrayList<Consumer> consumers

stickyKeyConsumerSelector

protected StickyKeyConsumerSelector stickyKeyConsumerSelector

isKeyHashRangeFiltered

protected boolean isKeyHashRangeFiltered

closeFuture

protected CompletableFuture<Void> closeFuture

partitionIndex

protected final int partitionIndex

cursor

protected final ManagedCursor cursor

subscriptionType

protected final org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subscriptionType

FALSE

protected static final int FALSE

See Also:

• Constant Field Values

TRUE

protected static final int TRUE

See Also:

• Constant Field Values

IS_CLOSED_UPDATER

protected static final AtomicIntegerFieldUpdater<AbstractDispatcherSingleActiveConsumer> IS_CLOSED_UPDATER

isFirstRead

protected boolean isFirstRead

Constructor Details

AbstractDispatcherSingleActiveConsumer

public AbstractDispatcherSingleActiveConsumer(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subscriptionType,
 int partitionIndex,
 String topicName,
 Subscription subscription,
 ServiceConfiguration serviceConfig,
 ManagedCursor cursor)

Method Details

scheduleReadOnActiveConsumer

protected abstract void scheduleReadOnActiveConsumer()

cancelPendingRead

protected abstract void cancelPendingRead()

notifyActiveConsumerChanged

protected void notifyActiveConsumerChanged(Consumer activeConsumer)

pickAndScheduleActiveConsumer

protected boolean pickAndScheduleActiveConsumer()

Pick active consumer for a topic for CommandSubscribe.SubType.Failover subscription. If it's a non-partitioned topic then it'll pick consumer based on order they subscribe to the topic. If is's a partitioned topic, first sort consumers based on their priority level and consumer name then distributed partitions evenly across consumers with highest priority level.

Returns:

the true consumer if the consumer is changed, otherwise false.

addConsumer

public CompletableFuture<Void> addConsumer(Consumer consumer)

removeConsumer

public void removeConsumer(Consumer consumer)
                    throws BrokerServiceException

Throws:

BrokerServiceException

canUnsubscribe

public boolean canUnsubscribe(Consumer consumer)

Handle unsubscribe command from the client API For failover subscription, if consumer is connected consumer, we can unsubscribe.

Parameters:

consumer - Calling consumer object

close

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

isClosed

public boolean isClosed()

disconnectAllConsumers

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

Disconnect all consumers on this dispatcher (server side close). This triggers channelInactive on the inbound handler which calls dispatcher.removeConsumer(), where the closeFuture is completed.

Parameters:

isResetCursor - Specifies if the cursor has been reset.

assignedBrokerLookupData - Optional target broker redirect information. Allows the consumer to quickly reconnect to a broker during bundle unloading.

Returns:

CompletableFuture indicating the completion of the operation.

disconnectActiveConsumers

public CompletableFuture<Void> disconnectActiveConsumers(boolean isResetCursor)

Description copied from interface: Dispatcher

Disconnect active consumers.

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.

getType

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

getActiveConsumer

public Consumer getActiveConsumer()

getConsumers

public List<Consumer> getConsumers()

isConsumerConnected

public boolean isConsumerConnected()