Package org.apache.pulsar.broker.service.nonpersistent

Class NonPersistentSubscription

java.lang.Object

org.apache.pulsar.broker.service.AbstractSubscription

org.apache.pulsar.broker.service.nonpersistent.NonPersistentSubscription

All Implemented Interfaces:

Subscription

public class NonPersistentSubscription
extends AbstractSubscription
implements Subscription

Field Summary

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

bytesOutFromRemovedConsumers, msgOutFromRemovedConsumer

Constructor Summary

Constructors

Constructor	Description
NonPersistentSubscription(NonPersistentTopic topic, String subscriptionName, boolean isDurable, Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
void	acknowledgeMessage(List<org.apache.bookkeeper.mledger.Position> position, org.apache.pulsar.common.api.proto.CommandAck.AckType ackType, Map<String,Long> properties)
CompletableFuture<Void>	addConsumer(Consumer consumer)
void	addUnAckedMessages(int unAckMessages)
CompletableFuture<AnalyzeBacklogResult>	analyzeBacklog(Optional<org.apache.bookkeeper.mledger.Position> position)
CompletableFuture<Void>	clearBacklog()
CompletableFuture<Void>	close()
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)
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)
boolean	expireMessages(int messageTTLInSeconds)
boolean	expireMessages(org.apache.bookkeeper.mledger.Position position)
List<Consumer>	getConsumers()
NonPersistentDispatcher	getDispatcher()
double	getExpiredMessageRate()
long	getLastActive()
String	getName()
long	getNumberOfEntriesInBacklog(boolean getPreciseBacklog)
org.apache.pulsar.common.policies.data.stats.NonPersistentSubscriptionStatsImpl	getStats()
Map<String,String>	getSubscriptionProperties()
Topic	getTopic()
String	getTopicName()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
String	getTypeString()
BrokerInterceptor	interceptor()
boolean	isReplicated()
void	markTopicWithBatchMessagePublished()
CompletableFuture<org.apache.bookkeeper.mledger.Entry>	peekNthMessage(int messagePosition)
void	redeliverUnacknowledgedMessages(Consumer consumer, long consumerEpoch)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<org.apache.bookkeeper.mledger.impl.PositionImpl> positions)
void	removeConsumer(Consumer consumer, boolean isResetCursor)
CompletableFuture<Void>	resetCursor(long timestamp)
CompletableFuture<Void>	resetCursor(org.apache.bookkeeper.mledger.Position position)
CompletableFuture<Void>	skipMessages(int numMessagesToSkip)
String	toString()
void	updateLastActive()
CompletableFuture<Void>	updateSubscriptionProperties(Map<String,String> subscriptionProperties)

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

getNumberOfEntriesDelayed, getNumberOfSameAddressConsumers, processReplicatedSubscriptionSnapshot, removeConsumer

Constructor Details

NonPersistentSubscription

public NonPersistentSubscription(NonPersistentTopic topic,
 String subscriptionName,
 boolean isDurable,
 Map<String,String> properties)

Method Details

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

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

consumerFlow

public void consumerFlow(Consumer consumer,
 int additionalNumberOfMessages)

Specified by:

consumerFlow in interface Subscription

acknowledgeMessage

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

Specified by:

acknowledgeMessage in interface Subscription

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

peekNthMessage

public CompletableFuture<org.apache.bookkeeper.mledger.Entry> peekNthMessage(int messagePosition)

Specified by:

peekNthMessage in interface Subscription

getNumberOfEntriesInBacklog

public long getNumberOfEntriesInBacklog(boolean getPreciseBacklog)

Specified by:

getNumberOfEntriesInBacklog in interface Subscription

getDispatcher

public NonPersistentDispatcher getDispatcher()

Specified by:

getDispatcher in interface Subscription

close

public CompletableFuture<Void> close()

Specified by:

close in interface Subscription

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 ubsubscribe 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(org.apache.bookkeeper.mledger.Position position)

Specified by:

expireMessages in interface Subscription

getStats

public org.apache.pulsar.common.policies.data.stats.NonPersistentSubscriptionStatsImpl getStats()

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Consumer consumer,
 long consumerEpoch)

Specified by:

redeliverUnacknowledgedMessages in interface Subscription

redeliverUnacknowledgedMessages

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

Specified by:

redeliverUnacknowledgedMessages in interface Subscription

addUnAckedMessages

public void addUnAckedMessages(int unAckMessages)

Specified by:

addUnAckedMessages in interface Subscription

getExpiredMessageRate

public double getExpiredMessageRate()

Specified by:

getExpiredMessageRate in interface Subscription

markTopicWithBatchMessagePublished

public void markTopicWithBatchMessagePublished()

Specified by:

markTopicWithBatchMessagePublished in interface Subscription

resetCursor

public CompletableFuture<Void> resetCursor(org.apache.bookkeeper.mledger.Position position)

Specified by:

resetCursor in interface Subscription

endTxn

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

Specified by:

endTxn in interface Subscription

analyzeBacklog

public CompletableFuture<AnalyzeBacklogResult> analyzeBacklog(Optional<org.apache.bookkeeper.mledger.Position> position)

Specified by:

analyzeBacklog in interface Subscription

getLastActive

public long getLastActive()

updateLastActive

public void updateLastActive()

getSubscriptionProperties

public Map<String,String> getSubscriptionProperties()

Specified by:

getSubscriptionProperties in interface Subscription

updateSubscriptionProperties

public CompletableFuture<Void> updateSubscriptionProperties(Map<String,String> subscriptionProperties)

Specified by:

updateSubscriptionProperties in interface Subscription