Package org.apache.pulsar.client.impl

Class ConsumerBase<T>

java.lang.Object

org.apache.pulsar.client.impl.ConsumerBase<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<T>, MessageAcknowledger

Direct Known Subclasses:

ConsumerImpl, MultiTopicsConsumerImpl

public abstract class ConsumerBase<T>
extends Object
implements Consumer<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	ConsumerBase.OpBatchReceive<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final BatchReceivePolicy	batchReceivePolicy
protected io.netty.util.Timeout	batchReceiveTimeout
protected final PulsarClientImpl	client
protected final ConsumerConfigurationData<T>	conf
protected static final AtomicLongFieldUpdater<ConsumerBase>	CONSUMER_EPOCH
protected long	consumerEpoch
protected final ConsumerEventListener	consumerEventListener
protected final String	consumerName
protected static final AtomicIntegerFieldUpdater<ConsumerBase>	CURRENT_RECEIVER_QUEUE_SIZE_UPDATER
protected final ExecutorProvider	executorProvider
protected final ExecutorService	externalPinnedExecutor
protected long	incomingMessagesSize
protected final Lock	incomingQueueLock
protected static final int	INITIAL_RECEIVER_QUEUE_SIZE
protected final ConsumerInterceptors<T>	interceptors
protected final ExecutorService	internalPinnedExecutor
protected final MessageListener<T>	listener
protected final int	maxReceiverQueueSize
protected static final double	MEMORY_THRESHOLD_FOR_RECEIVER_QUEUE_SIZE_EXPANSION
protected static final AtomicIntegerFieldUpdater<ConsumerBase>	MESSAGE_LISTENER_QUEUE_SIZE_UPDATER
protected int	messageListenerQueueSize
protected final ConcurrentLinkedQueue<ConsumerBase.OpBatchReceive<T>>	pendingBatchReceives
protected final ConcurrentLinkedQueue<CompletableFuture<Message<T>>>	pendingReceives
protected URI	redirectedClusterURI
protected final AtomicBoolean	scaleReceiverQueueHint
protected final Schema<T>	schema
protected final CompletableFuture<Consumer<T>>	subscribeFuture
protected final String	subscription
protected final String	topic
protected ConcurrentOpenHashMap<MessageIdAdv,MessageIdImpl[]>	unAckedChunkedMessageIdSequenceMap
protected UnAckedMessageTracker	unAckedMessageTracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConsumerBase(PulsarClientImpl client, String topic, ConsumerConfigurationData<T> conf, int receiverQueueSize, ExecutorProvider executorProvider, CompletableFuture<Consumer<T>> subscribeFuture, Schema<T> schema, ConsumerInterceptors interceptors)

Method Summary

Modifier and Type	Method	Description
void	acknowledge(List<MessageId> messageIdList)
void	acknowledge(Message<?> message)
void	acknowledge(MessageId messageId)
void	acknowledge(Messages<?> messages)
CompletableFuture<Void>	acknowledgeAsync(List<MessageId> messageIdList)
CompletableFuture<Void>	acknowledgeAsync(List<MessageId> messageIdList, Transaction txn)
CompletableFuture<Void>	acknowledgeAsync(Message<?> message)
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId)
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId, Transaction txn)
CompletableFuture<Void>	acknowledgeAsync(Messages<?> messages)
CompletableFuture<Void>	acknowledgeAsync(Messages<?> messages, Transaction txn)
void	acknowledgeCumulative(Message<?> message)
void	acknowledgeCumulative(MessageId messageId)
CompletableFuture<Void>	acknowledgeCumulativeAsync(Message<?> message)
CompletableFuture<Void>	acknowledgeCumulativeAsync(MessageId messageId)
CompletableFuture<Void>	acknowledgeCumulativeAsync(MessageId messageId, Transaction txn)
Messages<T>	batchReceive()
CompletableFuture<Messages<T>>	batchReceiveAsync()
protected Message<T>	beforeConsume(Message<T> message)
protected void	callMessageListener(Message<T> msg)
protected boolean	canEnqueueMessage(Message<T> message)
protected boolean	changeToConnecting()
protected boolean	changeToReadyState()
protected boolean	changeToRegisteringSchemaState()
protected void	clearIncomingMessages()
void	close()
abstract CompletableFuture<Void>	closeAsync()
protected abstract void	completeOpBatchReceive(ConsumerBase.OpBatchReceive<T> op)
protected void	completePendingBatchReceive(CompletableFuture<Messages<T>> future, Messages<T> messages)
protected void	completePendingReceive(CompletableFuture<Message<T>> receivedFuture, Message<T> message)
protected void	decreaseIncomingMessageSize(Message<?> message)
protected abstract CompletableFuture<Void>	doAcknowledge(List<MessageId> messageIdList, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected abstract CompletableFuture<Void>	doAcknowledge(MessageId messageId, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected CompletableFuture<Void>	doAcknowledgeWithTxn(List<MessageId> messageIdList, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected CompletableFuture<Void>	doAcknowledgeWithTxn(MessageId messageId, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected abstract CompletableFuture<Void>	doReconsumeLater(Message<?> message, CommandAck.AckType ackType, Map<String,String> customProperties, long delayTime, TimeUnit unit)
protected boolean	enqueueMessageAndCheckBatchReceive(Message<T> message)
protected void	expectMoreIncomingMessages()
protected CompletableFuture<Void>	failPendingReceive()
protected org.apache.pulsar.client.impl.HandlerState.State	getAndUpdateState(UnaryOperator<org.apache.pulsar.client.impl.HandlerState.State> updater)
abstract int	getAvailablePermits()
PulsarClientImpl	getClient()
String	getConsumerName()
int	getCurrentReceiverQueueSize()
long	getIncomingMessageSize()
MessageId	getLastMessageId()	Deprecated.
abstract CompletableFuture<MessageId>	getLastMessageIdAsync()	Deprecated.
List<TopicMessageId>	getLastMessageIds()
protected MessagesImpl<T>	getNewMessagesImpl()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
String	getSubscription()
protected CommandSubscribe.SubType	getSubType()
String	getTopic()
int	getTotalIncomingMessages()
protected UnAckedMessageTracker	getUnAckedMessageTracker()
boolean	hasBatchReceiveTimeout()
protected boolean	hasEnoughMessagesForBatchReceive()
protected boolean	hasNextPendingReceive()
protected boolean	hasPendingBatchReceive()
void	initReceiverQueueSize()
protected abstract Messages<T>	internalBatchReceive()
protected abstract CompletableFuture<Messages<T>>	internalBatchReceiveAsync()
protected abstract Message<T>	internalReceive()
protected abstract Message<T>	internalReceive(long timeout, TimeUnit unit)
protected abstract CompletableFuture<Message<T>>	internalReceiveAsync()
protected boolean	isSingleMessageAcked(BitSetRecyclable ackBitSet, int batchIndex)
protected boolean	isValidConsumerEpoch(MessageImpl<T> message)
protected abstract void	messageProcessed(Message<?> msg)
abstract int	minReceiverQueueSize()
void	negativeAcknowledge(Message<?> message)
void	negativeAcknowledge(Messages<?> messages)
protected CompletableFuture<Message<T>>	nextPendingReceive()
protected void	notifyPendingBatchReceivedCallBack()
protected final void	notifyPendingBatchReceivedCallBack(CompletableFuture<Messages<T>> batchReceiveFuture)
abstract int	numMessagesInQueue()
protected void	onAcknowledge(List<MessageId> messageIds, Throwable exception)
protected void	onAcknowledge(MessageId messageId, Throwable exception)
protected void	onAcknowledgeCumulative(List<MessageId> messageIds, Throwable exception)
protected void	onAcknowledgeCumulative(MessageId messageId, Throwable exception)
protected void	onAckTimeoutSend(Set<MessageId> messageIds)
protected void	onNegativeAcksSend(Set<MessageId> messageIds)
protected void	onPartitionsChange(String topicName, int partitions)
protected byte[]	peekMessageKey(Message<T> msg)
Message<T>	receive()
Message<T>	receive(int timeout, TimeUnit unit)
CompletableFuture<Message<T>>	receiveAsync()
void	reconsumeLater(Message<?> message, long delayTime, TimeUnit unit)
void	reconsumeLater(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)
void	reconsumeLater(Messages<?> messages, long delayTime, TimeUnit unit)
CompletableFuture<Void>	reconsumeLaterAsync(Message<?> message, long delayTime, TimeUnit unit)
CompletableFuture<Void>	reconsumeLaterAsync(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)
CompletableFuture<Void>	reconsumeLaterAsync(Messages<?> messages, long delayTime, TimeUnit unit)
void	reconsumeLaterCumulative(Message<?> message, long delayTime, TimeUnit unit)
CompletableFuture<Void>	reconsumeLaterCumulativeAsync(Message<?> message, long delayTime, TimeUnit unit)
CompletableFuture<Void>	reconsumeLaterCumulativeAsync(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)
protected abstract void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds)	Redelivers the given unacknowledged messages.
protected void	reduceCurrentReceiverQueueSize()
protected void	resetIncomingMessageSize()
protected abstract void	setCurrentReceiverQueueSize(int newSize)	Update the size of the consumer receive queue.
protected void	setRedirectedClusterURI(String serviceUrl, String serviceUrlTls)
protected void	setState(org.apache.pulsar.client.impl.HandlerState.State s)
CompletableFuture<Consumer<T>>	subscribeFuture()
String	toString()
protected void	trackUnAckedMsgIfNoListener(MessageId messageId, int redeliveryCount)
protected void	triggerBatchReceiveTimeoutTask()
protected void	tryTriggerListener()
void	unsubscribe()
void	unsubscribe(boolean force)
CompletableFuture<Void>	unsubscribeAsync()
abstract CompletableFuture<Void>	unsubscribeAsync(boolean force)
protected abstract void	updateAutoScaleReceiverQueueHint()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Consumer

getLastDisconnectedTimestamp, getLastMessageIdsAsync, getStats, hasReachedEndOfTopic, isConnected, negativeAcknowledge, pause, redeliverUnacknowledgedMessages, resume, seek, seek, seek, seekAsync, seekAsync, seekAsync

Field Details

INITIAL_RECEIVER_QUEUE_SIZE

protected static final int INITIAL_RECEIVER_QUEUE_SIZE

See Also:

• Constant Field Values

MEMORY_THRESHOLD_FOR_RECEIVER_QUEUE_SIZE_EXPANSION

protected static final double MEMORY_THRESHOLD_FOR_RECEIVER_QUEUE_SIZE_EXPANSION

See Also:

• Constant Field Values

subscription

protected final String subscription

conf

protected final ConsumerConfigurationData<T> conf

consumerName

protected final String consumerName

subscribeFuture

protected final CompletableFuture<Consumer<T>> subscribeFuture

listener

protected final MessageListener<T> listener

consumerEventListener

protected final ConsumerEventListener consumerEventListener

executorProvider

protected final ExecutorProvider executorProvider

externalPinnedExecutor

protected final ExecutorService externalPinnedExecutor

internalPinnedExecutor

protected final ExecutorService internalPinnedExecutor

unAckedMessageTracker

protected UnAckedMessageTracker unAckedMessageTracker

unAckedChunkedMessageIdSequenceMap

protected ConcurrentOpenHashMap<MessageIdAdv,MessageIdImpl[]> unAckedChunkedMessageIdSequenceMap

pendingReceives

protected final ConcurrentLinkedQueue<CompletableFuture<Message<T>>> pendingReceives

maxReceiverQueueSize

protected final int maxReceiverQueueSize

MESSAGE_LISTENER_QUEUE_SIZE_UPDATER

protected static final AtomicIntegerFieldUpdater<ConsumerBase> MESSAGE_LISTENER_QUEUE_SIZE_UPDATER

messageListenerQueueSize

protected volatile int messageListenerQueueSize

CURRENT_RECEIVER_QUEUE_SIZE_UPDATER

protected static final AtomicIntegerFieldUpdater<ConsumerBase> CURRENT_RECEIVER_QUEUE_SIZE_UPDATER

schema

protected final Schema<T> schema

interceptors

protected final ConsumerInterceptors<T> interceptors

batchReceivePolicy

protected final BatchReceivePolicy batchReceivePolicy

pendingBatchReceives

protected final ConcurrentLinkedQueue<ConsumerBase.OpBatchReceive<T>> pendingBatchReceives

incomingMessagesSize

protected volatile long incomingMessagesSize

batchReceiveTimeout

protected volatile io.netty.util.Timeout batchReceiveTimeout

incomingQueueLock

protected final Lock incomingQueueLock

CONSUMER_EPOCH

protected static final AtomicLongFieldUpdater<ConsumerBase> CONSUMER_EPOCH

consumerEpoch

protected volatile long consumerEpoch

scaleReceiverQueueHint

protected final AtomicBoolean scaleReceiverQueueHint

client

protected final PulsarClientImpl client

topic

protected final String topic

redirectedClusterURI

protected volatile URI redirectedClusterURI

Constructor Details

ConsumerBase

protected ConsumerBase(PulsarClientImpl client,
 String topic,
 ConsumerConfigurationData<T> conf,
 int receiverQueueSize,
 ExecutorProvider executorProvider,
 CompletableFuture<Consumer<T>> subscribeFuture,
 Schema<T> schema,
 ConsumerInterceptors interceptors)

Method Details

getUnAckedMessageTracker

protected UnAckedMessageTracker getUnAckedMessageTracker()

triggerBatchReceiveTimeoutTask

protected void triggerBatchReceiveTimeoutTask()

initReceiverQueueSize

public void initReceiverQueueSize()

minReceiverQueueSize

public abstract int minReceiverQueueSize()

expectMoreIncomingMessages

protected void expectMoreIncomingMessages()

trackUnAckedMsgIfNoListener

protected void trackUnAckedMsgIfNoListener(MessageId messageId,
 int redeliveryCount)

reduceCurrentReceiverQueueSize

protected void reduceCurrentReceiverQueueSize()

receive

public Message<T> receive()
                   throws PulsarClientException

Specified by:

receive in interface Consumer<T>

Throws:

PulsarClientException

receiveAsync

public CompletableFuture<Message<T>> receiveAsync()

Specified by:

receiveAsync in interface Consumer<T>

internalReceive

protected abstract Message<T> internalReceive()
                                       throws PulsarClientException

Throws:

PulsarClientException

internalReceiveAsync

protected abstract CompletableFuture<Message<T>> internalReceiveAsync()

receive

public Message<T> receive(int timeout,
 TimeUnit unit)
                   throws PulsarClientException

Specified by:

receive in interface Consumer<T>

Throws:

PulsarClientException

internalReceive

protected abstract Message<T> internalReceive(long timeout,
 TimeUnit unit)
                                       throws PulsarClientException

Throws:

PulsarClientException

batchReceive

public Messages<T> batchReceive()
                         throws PulsarClientException

Specified by:

batchReceive in interface Consumer<T>

Throws:

PulsarClientException

batchReceiveAsync

public CompletableFuture<Messages<T>> batchReceiveAsync()

Specified by:

batchReceiveAsync in interface Consumer<T>

hasNextPendingReceive

protected boolean hasNextPendingReceive()

nextPendingReceive

protected CompletableFuture<Message<T>> nextPendingReceive()

completePendingReceive

protected void completePendingReceive(CompletableFuture<Message<T>> receivedFuture,
 Message<T> message)

failPendingReceive

protected CompletableFuture<Void> failPendingReceive()

internalBatchReceive

protected abstract Messages<T> internalBatchReceive()
                                             throws PulsarClientException

Throws:

PulsarClientException

internalBatchReceiveAsync

protected abstract CompletableFuture<Messages<T>> internalBatchReceiveAsync()

acknowledge

public void acknowledge(Message<?> message)
                 throws PulsarClientException

Specified by:

acknowledge in interface MessageAcknowledger

Throws:

PulsarClientException

acknowledge

public void acknowledge(MessageId messageId)
                 throws PulsarClientException

Specified by:

acknowledge in interface MessageAcknowledger

Throws:

PulsarClientException

acknowledge

public void acknowledge(List<MessageId> messageIdList)
                 throws PulsarClientException

Specified by:

acknowledge in interface MessageAcknowledger

Throws:

PulsarClientException

acknowledge

public void acknowledge(Messages<?> messages)
                 throws PulsarClientException

Specified by:

acknowledge in interface MessageAcknowledger

Throws:

PulsarClientException

reconsumeLater

public void reconsumeLater(Message<?> message,
 long delayTime,
 TimeUnit unit)
                    throws PulsarClientException

Specified by:

reconsumeLater in interface Consumer<T>

Throws:

PulsarClientException

reconsumeLater

public void reconsumeLater(Message<?> message,
 Map<String,String> customProperties,
 long delayTime,
 TimeUnit unit)
                    throws PulsarClientException

Specified by:

reconsumeLater in interface Consumer<T>

Throws:

PulsarClientException

reconsumeLater

public void reconsumeLater(Messages<?> messages,
 long delayTime,
 TimeUnit unit)
                    throws PulsarClientException

Specified by:

reconsumeLater in interface Consumer<T>

Throws:

PulsarClientException

acknowledgeCumulative

public void acknowledgeCumulative(Message<?> message)
                           throws PulsarClientException

Specified by:

acknowledgeCumulative in interface MessageAcknowledger

Throws:

PulsarClientException

acknowledgeCumulative

public void acknowledgeCumulative(MessageId messageId)
                           throws PulsarClientException

Specified by:

acknowledgeCumulative in interface MessageAcknowledger

Throws:

PulsarClientException

reconsumeLaterCumulative

public void reconsumeLaterCumulative(Message<?> message,
 long delayTime,
 TimeUnit unit)
                              throws PulsarClientException

Specified by:

reconsumeLaterCumulative in interface Consumer<T>

Throws:

PulsarClientException

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(Message<?> message)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(Messages<?> messages)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(Messages<?> messages,
 Transaction txn)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(List<MessageId> messageIdList)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(List<MessageId> messageIdList,
 Transaction txn)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

reconsumeLaterAsync

public CompletableFuture<Void> reconsumeLaterAsync(Message<?> message,
 long delayTime,
 TimeUnit unit)

Specified by:

reconsumeLaterAsync in interface Consumer<T>

reconsumeLaterAsync

public CompletableFuture<Void> reconsumeLaterAsync(Message<?> message,
 Map<String,String> customProperties,
 long delayTime,
 TimeUnit unit)

Specified by:

reconsumeLaterAsync in interface Consumer<T>

reconsumeLaterAsync

public CompletableFuture<Void> reconsumeLaterAsync(Messages<?> messages,
 long delayTime,
 TimeUnit unit)

Specified by:

reconsumeLaterAsync in interface Consumer<T>

acknowledgeCumulativeAsync

public CompletableFuture<Void> acknowledgeCumulativeAsync(Message<?> message)

Specified by:

acknowledgeCumulativeAsync in interface MessageAcknowledger

reconsumeLaterCumulativeAsync

public CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,
 long delayTime,
 TimeUnit unit)

Specified by:

reconsumeLaterCumulativeAsync in interface Consumer<T>

reconsumeLaterCumulativeAsync

public CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,
 Map<String,String> customProperties,
 long delayTime,
 TimeUnit unit)

Specified by:

reconsumeLaterCumulativeAsync in interface Consumer<T>

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(MessageId messageId)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(MessageId messageId,
 Transaction txn)

Specified by:

acknowledgeAsync in interface MessageAcknowledger

acknowledgeCumulativeAsync

public CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId)

Specified by:

acknowledgeCumulativeAsync in interface MessageAcknowledger

acknowledgeCumulativeAsync

public CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId,
 Transaction txn)

Specified by:

acknowledgeCumulativeAsync in interface MessageAcknowledger

negativeAcknowledge

public void negativeAcknowledge(Message<?> message)

Specified by:

negativeAcknowledge in interface Consumer<T>

doAcknowledgeWithTxn

protected CompletableFuture<Void> doAcknowledgeWithTxn(List<MessageId> messageIdList,
 CommandAck.AckType ackType,
 Map<String,Long> properties,
 TransactionImpl txn)

doAcknowledgeWithTxn

protected CompletableFuture<Void> doAcknowledgeWithTxn(MessageId messageId,
 CommandAck.AckType ackType,
 Map<String,Long> properties,
 TransactionImpl txn)

doAcknowledge

protected abstract CompletableFuture<Void> doAcknowledge(MessageId messageId,
 CommandAck.AckType ackType,
 Map<String,Long> properties,
 TransactionImpl txn)

doAcknowledge

protected abstract CompletableFuture<Void> doAcknowledge(List<MessageId> messageIdList,
 CommandAck.AckType ackType,
 Map<String,Long> properties,
 TransactionImpl txn)

doReconsumeLater

protected abstract CompletableFuture<Void> doReconsumeLater(Message<?> message,
 CommandAck.AckType ackType,
 Map<String,String> customProperties,
 long delayTime,
 TimeUnit unit)

negativeAcknowledge

public void negativeAcknowledge(Messages<?> messages)

Specified by:

negativeAcknowledge in interface Consumer<T>

unsubscribe

public void unsubscribe()
                 throws PulsarClientException

Specified by:

unsubscribe in interface Consumer<T>

Throws:

PulsarClientException

unsubscribe

public void unsubscribe(boolean force)
                 throws PulsarClientException

Specified by:

unsubscribe in interface Consumer<T>

Throws:

PulsarClientException

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync()

Specified by:

unsubscribeAsync in interface Consumer<T>

unsubscribeAsync

public abstract CompletableFuture<Void> unsubscribeAsync(boolean force)

Specified by:

unsubscribeAsync in interface Consumer<T>

close

public void close()
           throws PulsarClientException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Consumer<T>

Throws:

PulsarClientException

closeAsync

public abstract CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface Consumer<T>

getLastMessageId

@Deprecated
public MessageId getLastMessageId()
                           throws PulsarClientException

Deprecated.

Specified by:

getLastMessageId in interface Consumer<T>

Throws:

PulsarClientException

getLastMessageIdAsync

@Deprecated
public abstract CompletableFuture<MessageId> getLastMessageIdAsync()

Deprecated.

Specified by:

getLastMessageIdAsync in interface Consumer<T>

getLastMessageIds

public List<TopicMessageId> getLastMessageIds()
                                       throws PulsarClientException

Specified by:

getLastMessageIds in interface Consumer<T>

Throws:

PulsarClientException

getSubType

protected CommandSubscribe.SubType getSubType()

getAvailablePermits

public abstract int getAvailablePermits()

numMessagesInQueue

public abstract int numMessagesInQueue()

subscribeFuture

public CompletableFuture<Consumer<T>> subscribeFuture()

getTopic

public String getTopic()

Specified by:

getTopic in interface Consumer<T>

getSubscription

public String getSubscription()

Specified by:

getSubscription in interface Consumer<T>

getConsumerName

public String getConsumerName()

Specified by:

getConsumerName in interface Consumer<T>

redeliverUnacknowledgedMessages

protected abstract void redeliverUnacknowledgedMessages(Set<MessageId> messageIds)

Redelivers the given unacknowledged messages. In Failover mode, the request is ignored if the consumer is not active for the given topic. In Shared mode, the consumers messages to be redelivered are distributed across all the connected consumers. This is a non blocking call and doesn't throw an exception. In case the connection breaks, the messages are redelivered after reconnect.

toString

public String toString()

Overrides:

toString in class Object

beforeConsume

protected Message<T> beforeConsume(Message<T> message)

onAcknowledge

protected void onAcknowledge(MessageId messageId,
 Throwable exception)

onAcknowledge

protected void onAcknowledge(List<MessageId> messageIds,
 Throwable exception)

onAcknowledgeCumulative

protected void onAcknowledgeCumulative(MessageId messageId,
 Throwable exception)

onAcknowledgeCumulative

protected void onAcknowledgeCumulative(List<MessageId> messageIds,
 Throwable exception)

onNegativeAcksSend

protected void onNegativeAcksSend(Set<MessageId> messageIds)

onAckTimeoutSend

protected void onAckTimeoutSend(Set<MessageId> messageIds)

onPartitionsChange

protected void onPartitionsChange(String topicName,
 int partitions)

canEnqueueMessage

protected boolean canEnqueueMessage(Message<T> message)

enqueueMessageAndCheckBatchReceive

protected boolean enqueueMessageAndCheckBatchReceive(Message<T> message)

updateAutoScaleReceiverQueueHint

protected abstract void updateAutoScaleReceiverQueueHint()

hasEnoughMessagesForBatchReceive

protected boolean hasEnoughMessagesForBatchReceive()

notifyPendingBatchReceivedCallBack

protected void notifyPendingBatchReceivedCallBack()

notifyPendingBatchReceivedCallBack

protected final void notifyPendingBatchReceivedCallBack(CompletableFuture<Messages<T>> batchReceiveFuture)

completePendingBatchReceive

protected void completePendingBatchReceive(CompletableFuture<Messages<T>> future,
 Messages<T> messages)

messageProcessed

protected abstract void messageProcessed(Message<?> msg)

tryTriggerListener

protected void tryTriggerListener()

callMessageListener

protected void callMessageListener(Message<T> msg)

peekMessageKey

protected byte[] peekMessageKey(Message<T> msg)

getNewMessagesImpl

protected MessagesImpl<T> getNewMessagesImpl()

hasPendingBatchReceive

protected boolean hasPendingBatchReceive()

resetIncomingMessageSize

protected void resetIncomingMessageSize()

decreaseIncomingMessageSize

protected void decreaseIncomingMessageSize(Message<?> message)

getIncomingMessageSize

public long getIncomingMessageSize()

getTotalIncomingMessages

public int getTotalIncomingMessages()

clearIncomingMessages

protected void clearIncomingMessages()

setCurrentReceiverQueueSize

protected abstract void setCurrentReceiverQueueSize(int newSize)

Update the size of the consumer receive queue. See ConsumerBuilder.receiverQueueSize(int).

Parameters:

newSize - new size of the receiver queue.

getCurrentReceiverQueueSize

public int getCurrentReceiverQueueSize()

completeOpBatchReceive

protected abstract void completeOpBatchReceive(ConsumerBase.OpBatchReceive<T> op)

isValidConsumerEpoch

protected boolean isValidConsumerEpoch(MessageImpl<T> message)

isSingleMessageAcked

protected boolean isSingleMessageAcked(BitSetRecyclable ackBitSet,
 int batchIndex)

hasBatchReceiveTimeout

public boolean hasBatchReceiveTimeout()

setRedirectedClusterURI

protected void setRedirectedClusterURI(String serviceUrl,
 String serviceUrlTls)
                                throws URISyntaxException

Throws:

URISyntaxException

changeToReadyState

protected boolean changeToReadyState()

changeToRegisteringSchemaState

protected boolean changeToRegisteringSchemaState()

getState

protected org.apache.pulsar.client.impl.HandlerState.State getState()

changeToConnecting

protected boolean changeToConnecting()

setState

protected void setState(org.apache.pulsar.client.impl.HandlerState.State s)

getAndUpdateState

protected org.apache.pulsar.client.impl.HandlerState.State getAndUpdateState(UnaryOperator<org.apache.pulsar.client.impl.HandlerState.State> updater)

getClient

public PulsarClientImpl getClient()