org.apache.pulsar.broker.service

Interface Subscription

All Known Implementing Classes:

CompactorSubscription, NonPersistentSubscription, PersistentSubscription

public interface Subscription

Method Summary

Modifier and Type	Method and Description
void	acknowledgeMessage(List<Position> positions, org.apache.pulsar.common.api.proto.PulsarApi.CommandAck.AckType ackType, Map<String,Long> properties)
void	addConsumer(Consumer consumer)
void	addUnAckedMessages(int unAckMessages)
CompletableFuture<Void>	clearBacklog()
CompletableFuture<Void>	close()
void	consumerFlow(Consumer consumer, int additionalNumberOfMessages)
CompletableFuture<Void>	delete()
CompletableFuture<Void>	deleteForcefully()
CompletableFuture<Void>	disconnect()
CompletableFuture<Void>	doUnsubscribe(Consumer consumer)
CompletableFuture<Void>	endTxn(long txnidMostBits, long txnidLeastBits, int txnAction)
boolean	expireMessages(int messageTTLInSeconds)
boolean	expireMessages(Position position)
List<Consumer>	getConsumers()
Dispatcher	getDispatcher()
double	getExpiredMessageRate()
String	getName()
default long	getNumberOfEntriesDelayed()
long	getNumberOfEntriesInBacklog(boolean getPreciseBacklog)
Topic	getTopic()
String	getTopicName()
org.apache.pulsar.common.api.proto.PulsarApi.CommandSubscribe.SubType	getType()
String	getTypeString()
BrokerInterceptor	interceptor()
static boolean	isCumulativeAckMode(org.apache.pulsar.common.api.proto.PulsarApi.CommandSubscribe.SubType subType)
static boolean	isIndividualAckMode(org.apache.pulsar.common.api.proto.PulsarApi.CommandSubscribe.SubType subType)
boolean	isReplicated()
void	markTopicWithBatchMessagePublished()
CompletableFuture<Entry>	peekNthMessage(int messagePosition)
default void	processReplicatedSubscriptionSnapshot(org.apache.pulsar.common.api.proto.PulsarMarkers.ReplicatedSubscriptionsSnapshot snapshot)
void	redeliverUnacknowledgedMessages(Consumer consumer)
void	redeliverUnacknowledgedMessages(Consumer consumer, List<PositionImpl> 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)

Method Detail

interceptor

BrokerInterceptor interceptor()

getTopic

Topic getTopic()

getName

String getName()

addConsumer

void addConsumer(Consumer consumer)
          throws BrokerServiceException

Throws:

BrokerServiceException

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.PulsarApi.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()

close

CompletableFuture<Void> close()

delete

CompletableFuture<Void> delete()

deleteForcefully

CompletableFuture<Void> deleteForcefully()

disconnect

CompletableFuture<Void> disconnect()

doUnsubscribe

CompletableFuture<Void> doUnsubscribe(Consumer consumer)

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)

expireMessages

boolean expireMessages(int messageTTLInSeconds)

expireMessages

boolean expireMessages(Position position)

redeliverUnacknowledgedMessages

void redeliverUnacknowledgedMessages(Consumer consumer)

redeliverUnacknowledgedMessages

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

markTopicWithBatchMessagePublished

void markTopicWithBatchMessagePublished()

getExpiredMessageRate

double getExpiredMessageRate()

getType

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

getTypeString

String getTypeString()

addUnAckedMessages

void addUnAckedMessages(int unAckMessages)

processReplicatedSubscriptionSnapshot

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

endTxn

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

isCumulativeAckMode

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

isIndividualAckMode

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