Package org.apache.pulsar.broker.service

Interface Subscription

All Superinterfaces:

MessageExpirer

All Known Implementing Classes:

AbstractSubscription, NonPersistentSubscription, PersistentSubscription, PulsarCompactorSubscription

public interface Subscription
extends MessageExpirer

Method Summary

Modifier and Type	Method	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)
CompletableFuture<AnalyzeBacklogResult>	analyzeBacklog(Optional<Position> position)
CompletableFuture<Void>	clearBacklog()
CompletableFuture<Void>	close(boolean disconnectConsumers, Optional<BrokerLookupData> assignedBrokerLookupData)
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)
CompletableFuture<Void>	delete()
CompletableFuture<Void>	deleteForcefully()
CompletableFuture<Void>	disconnect(Optional<BrokerLookupData> assignedBrokerLookupData)
CompletableFuture<Void>	doUnsubscribe(Consumer consumer)
CompletableFuture<Void>	doUnsubscribe(Consumer consumer, boolean forcefully)
CompletableFuture<Void>	endTxn(long txnidMostBits, long txnidLeastBits, int txnAction, long lowWaterMark)
List<Consumer>	getConsumers()
Dispatcher	getDispatcher()
double	getExpiredMessageRate()
String	getName()
default long	getNumberOfEntriesDelayed()
long	getNumberOfEntriesInBacklog(boolean getPreciseBacklog)
default int	getNumberOfSameAddressConsumers(String clientAddress)
Map<String,String>	getSubscriptionProperties()
Topic	getTopic()
String	getTopicName()
org.apache.pulsar.common.api.proto.CommandSubscribe.SubType	getType()
String	getTypeString()
BrokerInterceptor	interceptor()
static boolean	isCumulativeAckMode(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subType)
static boolean	isIndividualAckMode(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subType)
boolean	isReplicated()
boolean	isSubscriptionMigrated()
void	markTopicWithBatchMessagePublished()
CompletableFuture<Entry>	peekNthMessage(int messagePosition)
default void	processReplicatedSubscriptionSnapshot(org.apache.pulsar.common.api.proto.ReplicatedSubscriptionsSnapshot snapshot)
void	redeliverUnacknowledgedMessages(Consumer consumer, long consumerEpoch)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<Position> positions)
default void	removeConsumer(Consumer consumer)
void	removeConsumer(Consumer consumer, boolean isResetCursor)
CompletableFuture<Void>	resetCursor(long timestamp)
CompletableFuture<Void>	resetCursor(Position position)
CompletableFuture<Void>	skipMessages(int numMessagesToSkip)
CompletableFuture<Void>	updateSubscriptionProperties(Map<String,String> subscriptionProperties)

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

expireMessages, expireMessages

Method Details

interceptor

BrokerInterceptor interceptor()

getTopic

Topic getTopic()

getName

String getName()

addConsumer

CompletableFuture<Void> addConsumer(Consumer consumer)

removeConsumer

default void removeConsumer(Consumer consumer)
                     throws BrokerServiceException

Throws:

BrokerServiceException

removeConsumer

void removeConsumer(Consumer consumer,
 boolean isResetCursor)
             throws BrokerServiceException

Throws:

BrokerServiceException

consumerFlow

void consumerFlow(Consumer consumer,
 int additionalNumberOfMessages)

acknowledgeMessage

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

getTopicName

String getTopicName()

isReplicated

boolean isReplicated()

getDispatcher

Dispatcher getDispatcher()

getNumberOfEntriesInBacklog

long getNumberOfEntriesInBacklog(boolean getPreciseBacklog)

getNumberOfEntriesDelayed

default long getNumberOfEntriesDelayed()

getConsumers

List<Consumer> getConsumers()

delete

CompletableFuture<Void> delete()

deleteForcefully

CompletableFuture<Void> deleteForcefully()

disconnect

CompletableFuture<Void> disconnect(Optional<BrokerLookupData> assignedBrokerLookupData)

close

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

doUnsubscribe

CompletableFuture<Void> doUnsubscribe(Consumer consumer)

doUnsubscribe

CompletableFuture<Void> doUnsubscribe(Consumer consumer,
 boolean forcefully)

clearBacklog

CompletableFuture<Void> clearBacklog()

skipMessages

CompletableFuture<Void> skipMessages(int numMessagesToSkip)

resetCursor

CompletableFuture<Void> resetCursor(long timestamp)

resetCursor

CompletableFuture<Void> resetCursor(Position position)

peekNthMessage

CompletableFuture<Entry> peekNthMessage(int messagePosition)

redeliverUnacknowledgedMessages

void redeliverUnacknowledgedMessages(Consumer consumer,
 long consumerEpoch)

redeliverUnacknowledgedMessages

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

markTopicWithBatchMessagePublished

void markTopicWithBatchMessagePublished()

getExpiredMessageRate

double getExpiredMessageRate()

getType

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

getTypeString

String getTypeString()

addUnAckedMessages

void addUnAckedMessages(int unAckMessages)

getSubscriptionProperties

Map<String,String> getSubscriptionProperties()

updateSubscriptionProperties

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

isSubscriptionMigrated

boolean isSubscriptionMigrated()

processReplicatedSubscriptionSnapshot

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

endTxn

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

analyzeBacklog

CompletableFuture<AnalyzeBacklogResult> analyzeBacklog(Optional<Position> position)

getNumberOfSameAddressConsumers

default int getNumberOfSameAddressConsumers(String clientAddress)

isCumulativeAckMode

static boolean isCumulativeAckMode(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subType)

isIndividualAckMode

static boolean isIndividualAckMode(org.apache.pulsar.common.api.proto.CommandSubscribe.SubType subType)