org.apache.pulsar.broker.service.persistent

Class PersistentSubscription

java.lang.Object

org.apache.pulsar.broker.service.AbstractSubscription

org.apache.pulsar.broker.service.persistent.PersistentSubscription

All Implemented Interfaces:

Subscription

Direct Known Subclasses:

CompactorSubscription

public class PersistentSubscription
extends AbstractSubscription
implements Subscription

Field Summary

Fields

Modifier and Type	Field and Description
protected ManagedCursor	cursor
protected Dispatcher	dispatcher
protected String	fullName
protected String	subName
protected PersistentTopic	topic
protected String	topicName

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

bytesOutFromRemovedConsumers, msgOutFromRemovedConsumer

Constructor Summary

Constructors

Constructor and Description
PersistentSubscription(PersistentTopic topic, String subscriptionName, ManagedCursor cursor, boolean replicated)

Method Summary

Modifier and Type	Method and Description
void	acknowledgeMessage(List<Position> positions, org.apache.pulsar.common.api.proto.CommandAck.AckType ackType, Map<String,Long> properties)
CompletableFuture<Void>	addConsumer(Consumer consumer)
void	addUnAckedMessages(int unAckMessages)
boolean	checkAndUnblockIfStuck()
boolean	checkIfPendingAckStoreInit()
boolean	checkIsCanDeleteConsumerPendingAck(PositionImpl position)
CompletableFuture<Void>	clearBacklog()
CompletableFuture<Void>	close() Close the cursor ledger for this subscription.
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)
void	deactivateCursor()
CompletableFuture<Void>	delete() Delete the subscription by closing and deleting its managed cursor if no consumers are connected to it.
CompletableFuture<Void>	deleteForcefully() Forcefully close all consumers and deletes the subscription.
CompletableFuture<Void>	disconnect() Disconnect all consumers attached to the dispatcher and close this subscription.
CompletableFuture<Void>	doUnsubscribe(Consumer consumer) Handle unsubscribe command from the client API Check with the dispatcher is this consumer can proceed with unsubscribe.
CompletableFuture<Void>	endTxn(long txnidMostBits, long txnidLeastBits, int txnAction, long lowWaterMark)
long	estimateBacklogSize()
boolean	expireMessages(int messageTTLInSeconds)
boolean	expireMessages(Position position)
List<Consumer>	getConsumers()
ManagedCursor	getCursor()
Dispatcher	getDispatcher()
double	getExpiredMessageRate()
PersistentMessageExpiryMonitor	getExpiryMonitor()
String	getName()
long	getNumberOfEntriesDelayed()
long	getNumberOfEntriesInBacklog(boolean getPreciseBacklog)
long	getNumberOfEntriesSinceFirstNotAckedMessage()
CompletableFuture<ManagedLedger>	getPendingAckManageLedger()
org.apache.pulsar.common.policies.data.stats.SubscriptionStatsImpl	getStats(Boolean getPreciseBacklog, boolean subscriptionBacklogSize)
Topic	getTopic()
String	getTopicName()
int	getTotalNonContiguousDeletedMessagesRange()
org.apache.pulsar.common.policies.data.TransactionInPendingAckStats	getTransactionInPendingAckStats(org.apache.pulsar.client.api.transaction.TxnID txnID)
org.apache.pulsar.common.policies.data.TransactionPendingAckStats	getTransactionPendingAckStats()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
String	getTypeString()
BrokerInterceptor	interceptor()
boolean	isReplicated()
void	markTopicWithBatchMessagePublished()
protected Map<String,Long>	mergeCursorProperties(Map<String,Long> userProperties) Return a merged map that contains the cursor properties specified by used (eg.
CompletableFuture<Entry>	peekNthMessage(int messagePosition)
void	processReplicatedSubscriptionSnapshot(org.apache.pulsar.common.api.proto.ReplicatedSubscriptionsSnapshot snapshot)
void	redeliverUnacknowledgedMessages(Consumer consumer)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<PositionImpl> positions)
void	removeConsumer(Consumer consumer, boolean isResetCursor)
CompletableFuture<Void>	resetCursor(long timestamp)
CompletableFuture<Void>	resetCursor(Position position)
boolean	setReplicated(boolean replicated)
CompletableFuture<Void>	skipMessages(int numMessagesToSkip)
void	syncBatchPositionBitSetForPendingAck(PositionImpl position)
String	toString()
CompletableFuture<Void>	transactionCumulativeAcknowledge(org.apache.pulsar.client.api.transaction.TxnID txnId, List<PositionImpl> positions)
CompletableFuture<Void>	transactionIndividualAcknowledge(org.apache.pulsar.client.api.transaction.TxnID txnId, List<org.apache.commons.lang3.tuple.MutablePair<PositionImpl,Integer>> positions)
void	updateLastMarkDeleteAdvancedTimestamp()

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

getBytesOutCounter, getMsgOutCounter

Methods inherited from class java.lang.Object

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

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

getNumberOfSameAddressConsumers, isCumulativeAckMode, isIndividualAckMode, removeConsumer

Field Detail

topic

protected final PersistentTopic topic

cursor

protected final ManagedCursor cursor

dispatcher

protected volatile Dispatcher dispatcher

topicName

protected final String topicName

subName

protected final String subName

fullName

protected final String fullName

Constructor Detail

PersistentSubscription

public PersistentSubscription(PersistentTopic topic,
                              String subscriptionName,
                              ManagedCursor cursor,
                              boolean replicated)

Method Detail

updateLastMarkDeleteAdvancedTimestamp

public void updateLastMarkDeleteAdvancedTimestamp()

interceptor

public BrokerInterceptor interceptor()

Specified by:

interceptor in interface Subscription

getName

public String getName()

Specified by:

getName in interface Subscription

getTopic

public Topic getTopic()

Specified by:

getTopic in interface Subscription

isReplicated

public boolean isReplicated()

Specified by:

isReplicated in interface Subscription

setReplicated

public boolean setReplicated(boolean replicated)

addConsumer

public CompletableFuture<Void> addConsumer(Consumer consumer)

Specified by:

addConsumer in interface Subscription

removeConsumer

public void removeConsumer(Consumer consumer,
                           boolean isResetCursor)
                    throws BrokerServiceException

Specified by:

removeConsumer in interface Subscription

Throws:

BrokerServiceException

deactivateCursor

public void deactivateCursor()

consumerFlow

public void consumerFlow(Consumer consumer,
                         int additionalNumberOfMessages)

Specified by:

consumerFlow in interface Subscription

acknowledgeMessage

public void acknowledgeMessage(List<Position> positions,
                               org.apache.pulsar.common.api.proto.CommandAck.AckType ackType,
                               Map<String,Long> properties)

Specified by:

acknowledgeMessage in interface Subscription

transactionIndividualAcknowledge

public CompletableFuture<Void> transactionIndividualAcknowledge(org.apache.pulsar.client.api.transaction.TxnID txnId,
                                                                List<org.apache.commons.lang3.tuple.MutablePair<PositionImpl,Integer>> positions)

transactionCumulativeAcknowledge

public CompletableFuture<Void> transactionCumulativeAcknowledge(org.apache.pulsar.client.api.transaction.TxnID txnId,
                                                                List<PositionImpl> positions)

toString

public String toString()

Overrides:

toString in class Object

getTopicName

public String getTopicName()

Specified by:

getTopicName in interface Subscription

getType

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

Specified by:

getType in interface Subscription

getTypeString

public String getTypeString()

Specified by:

getTypeString in interface Subscription

clearBacklog

public CompletableFuture<Void> clearBacklog()

Specified by:

clearBacklog in interface Subscription

skipMessages

public CompletableFuture<Void> skipMessages(int numMessagesToSkip)

Specified by:

skipMessages in interface Subscription

resetCursor

public CompletableFuture<Void> resetCursor(long timestamp)

Specified by:

resetCursor in interface Subscription

resetCursor

public CompletableFuture<Void> resetCursor(Position position)

Specified by:

resetCursor in interface Subscription

peekNthMessage

public CompletableFuture<Entry> peekNthMessage(int messagePosition)

Specified by:

peekNthMessage in interface Subscription

getNumberOfEntriesInBacklog

public long getNumberOfEntriesInBacklog(boolean getPreciseBacklog)

Specified by:

getNumberOfEntriesInBacklog in interface Subscription

getDispatcher

public Dispatcher getDispatcher()

Specified by:

getDispatcher in interface Subscription

getNumberOfEntriesSinceFirstNotAckedMessage

public long getNumberOfEntriesSinceFirstNotAckedMessage()

getTotalNonContiguousDeletedMessagesRange

public int getTotalNonContiguousDeletedMessagesRange()

close

public CompletableFuture<Void> close()

Close the cursor ledger for this subscription. Requires that there are no active consumers on the dispatcher

Specified by:

close in interface Subscription

Returns:

CompletableFuture indicating the completion of delete operation

disconnect

public CompletableFuture<Void> disconnect()

Disconnect all consumers attached to the dispatcher and close this subscription.

Specified by:

disconnect in interface Subscription

Returns:

CompletableFuture indicating the completion of disconnect operation

delete

public CompletableFuture<Void> delete()

Delete the subscription by closing and deleting its managed cursor if no consumers are connected to it. Handle unsubscribe call from admin layer.

Specified by:

delete in interface Subscription

Returns:

CompletableFuture indicating the completion of delete operation

deleteForcefully

public CompletableFuture<Void> deleteForcefully()

Forcefully close all consumers and deletes the subscription.

Specified by:

deleteForcefully in interface Subscription

Returns:

doUnsubscribe

public CompletableFuture<Void> doUnsubscribe(Consumer consumer)

Handle unsubscribe command from the client API Check with the dispatcher is this consumer can proceed with unsubscribe.

Specified by:

doUnsubscribe in interface Subscription

Parameters:

consumer - consumer object that is initiating the unsubscribe operation

Returns:

CompletableFuture indicating the completion of unsubscribe operation

getConsumers

public List<Consumer> getConsumers()

Specified by:

getConsumers in interface Subscription

expireMessages

public boolean expireMessages(int messageTTLInSeconds)

Specified by:

expireMessages in interface Subscription

expireMessages

public boolean expireMessages(Position position)

Specified by:

expireMessages in interface Subscription

getExpiredMessageRate

public double getExpiredMessageRate()

Specified by:

getExpiredMessageRate in interface Subscription

getExpiryMonitor

public PersistentMessageExpiryMonitor getExpiryMonitor()

estimateBacklogSize

public long estimateBacklogSize()

getStats

public org.apache.pulsar.common.policies.data.stats.SubscriptionStatsImpl getStats(Boolean getPreciseBacklog,
                                                                                   boolean subscriptionBacklogSize)

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Consumer consumer)

Specified by:

redeliverUnacknowledgedMessages in interface Subscription

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Consumer consumer,
                                            List<PositionImpl> positions)

Specified by:

redeliverUnacknowledgedMessages in interface Subscription

addUnAckedMessages

public void addUnAckedMessages(int unAckMessages)

Specified by:

addUnAckedMessages in interface Subscription

getNumberOfEntriesDelayed

public long getNumberOfEntriesDelayed()

Specified by:

getNumberOfEntriesDelayed in interface Subscription

markTopicWithBatchMessagePublished

public void markTopicWithBatchMessagePublished()

Specified by:

markTopicWithBatchMessagePublished in interface Subscription

mergeCursorProperties

protected Map<String,Long> mergeCursorProperties(Map<String,Long> userProperties)

Return a merged map that contains the cursor properties specified by used (eg. when using compaction subscription) and the subscription properties.

processReplicatedSubscriptionSnapshot

public void processReplicatedSubscriptionSnapshot(org.apache.pulsar.common.api.proto.ReplicatedSubscriptionsSnapshot snapshot)

Specified by:

processReplicatedSubscriptionSnapshot in interface Subscription

endTxn

public CompletableFuture<Void> endTxn(long txnidMostBits,
                                      long txnidLeastBits,
                                      int txnAction,
                                      long lowWaterMark)

Specified by:

endTxn in interface Subscription

getCursor

public ManagedCursor getCursor()

syncBatchPositionBitSetForPendingAck

public void syncBatchPositionBitSetForPendingAck(PositionImpl position)

checkIsCanDeleteConsumerPendingAck

public boolean checkIsCanDeleteConsumerPendingAck(PositionImpl position)

getTransactionPendingAckStats

public org.apache.pulsar.common.policies.data.TransactionPendingAckStats getTransactionPendingAckStats()

checkAndUnblockIfStuck

public boolean checkAndUnblockIfStuck()

getTransactionInPendingAckStats

public org.apache.pulsar.common.policies.data.TransactionInPendingAckStats getTransactionInPendingAckStats(org.apache.pulsar.client.api.transaction.TxnID txnID)

getPendingAckManageLedger

public CompletableFuture<ManagedLedger> getPendingAckManageLedger()

checkIfPendingAckStoreInit

public boolean checkIfPendingAckStoreInit()