Package org.apache.pulsar.client.impl

Class ConsumerImpl<T>

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<T>, MessageAcknowledger

Direct Known Subclasses:

ZeroQueueConsumerImpl

public class ConsumerImpl<T>
extends ConsumerBase<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pulsar.client.impl.ConsumerBase

ConsumerBase.OpBatchReceive<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected ConcurrentOpenHashMap<String,org.apache.pulsar.client.impl.ConsumerImpl.ChunkedMessageCtx>	chunkedMessagesMap
protected final PulsarClientImpl	client
protected long	expireTimeOfIncompleteChunkedMessageMillis
protected MessageId	lastDequeuedMessageId
protected boolean	paused
protected URI	redirectedClusterURI
protected final ConsumerStatsRecorder	stats
protected final String	topic

Fields inherited from class org.apache.pulsar.client.impl.ConsumerBase

batchReceivePolicy, batchReceiveTimeout, conf, CONSUMER_EPOCH, consumerEpoch, consumerEventListener, consumerName, CURRENT_RECEIVER_QUEUE_SIZE_UPDATER, executorProvider, externalPinnedExecutor, incomingMessagesSize, incomingQueueLock, INITIAL_RECEIVER_QUEUE_SIZE, interceptors, internalPinnedExecutor, listener, maxReceiverQueueSize, MEMORY_THRESHOLD_FOR_RECEIVER_QUEUE_SIZE_EXPANSION, pendingBatchReceives, pendingReceives, scaleReceiverQueueHint, schema, subscribeFuture, subscription, unAckedChunkedMessageIdSequenceMap, unAckedMessageTracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConsumerImpl(PulsarClientImpl client, String topic, ConsumerConfigurationData<T> conf, ExecutorProvider executorProvider, int partitionIndex, boolean hasParentConsumer, boolean parentConsumerHasListener, CompletableFuture<Consumer<T>> subscribeFuture, MessageId startMessageId, long startMessageRollbackDurationInSec, Schema<T> schema, ConsumerInterceptors<T> interceptors, boolean createTopicIfDoesNotExist)

Method Summary

Modifier and Type	Method	Description
protected boolean	changeToConnecting()
protected boolean	changeToReadyState()
protected boolean	changeToRegisteringSchemaState()
CompletableFuture<Void>	closeAsync()
protected void	completeOpBatchReceive(ConsumerBase.OpBatchReceive<T> op)
void	connectionFailed(PulsarClientException exception)
void	connectionOpened(ClientCnx cnx)
protected void	consumerIsReconnectedToBroker(ClientCnx cnx, int currentQueueSize)
protected CompletableFuture<Void>	doAcknowledge(List<MessageId> messageIdList, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected CompletableFuture<Void>	doAcknowledge(MessageId messageId, CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected CompletableFuture<Void>	doReconsumeLater(Message<?> message, CommandAck.AckType ackType, Map<String,String> customProperties, long delayTime, TimeUnit unit)
boolean	equals(Object o)
protected org.apache.pulsar.client.impl.HandlerState.State	getAndUpdateState(UnaryOperator<org.apache.pulsar.client.impl.HandlerState.State> updater)
int	getAvailablePermits()
PulsarClientImpl	getClient()
ClientCnx	getClientCnx()
ConnectionHandler	getConnectionHandler()
long	getLastDisconnectedTimestamp()
CompletableFuture<MessageId>	getLastMessageIdAsync()	Deprecated.
CompletableFuture<List<TopicMessageId>>	getLastMessageIdsAsync()
Map<MessageIdAdv,List<MessageImpl<T>>>	getPossibleSendToDeadLetterTopicMessages()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
ConsumerStatsRecorder	getStats()
String	getTopicNameWithoutPartition()	Deprecated.
UnAckedMessageTracker	getUnAckedMessageTracker()
int	hashCode()
boolean	hasMessageAvailable()
CompletableFuture<Boolean>	hasMessageAvailableAsync()
boolean	hasReachedEndOfTopic()
void	increaseAvailablePermits(int delta)
protected void	increaseAvailablePermits(ClientCnx currentCnx, int delta)
protected Messages<T>	internalBatchReceive()
protected CompletableFuture<Messages<T>>	internalBatchReceiveAsync()
CompletableFuture<org.apache.pulsar.client.impl.ConsumerImpl.GetLastMessageIdResponse>	internalGetLastMessageIdAsync()
protected Message<T>	internalReceive()
protected Message<T>	internalReceive(long timeout, TimeUnit unit)
protected CompletableFuture<Message<T>>	internalReceiveAsync()
protected boolean	isBatch(MessageMetadata messageMetadata)
boolean	isConnected()
boolean	isConnected(ClientCnx cnx)
protected void	messageProcessed(Message<?> msg)	Record the event that one message has been processed by the application.
int	minReceiverQueueSize()
void	negativeAcknowledge(Message<?> message)
void	negativeAcknowledge(MessageId messageId)
protected <V> MessageImpl<V>	newMessage(MessageIdImpl messageId, BrokerEntryMetadata brokerEntryMetadata, MessageMetadata messageMetadata, io.netty.buffer.ByteBuf payload, Schema<V> schema, int redeliveryCount, long consumerEpoch)
protected <V> MessageImpl<V>	newSingleMessage(int index, int numMessages, BrokerEntryMetadata brokerEntryMetadata, MessageMetadata msgMetadata, SingleMessageMetadata singleMessageMetadata, io.netty.buffer.ByteBuf payload, MessageIdImpl messageId, Schema<V> schema, boolean containMetadata, BitSetRecyclable ackBitSet, BitSet ackSetInMessageId, int redeliveryCount, long consumerEpoch)
int	numMessagesInQueue()
void	pause()
void	redeliverUnacknowledgedMessages()
void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds)	Redelivers the given unacknowledged messages.
protected void	removeExpireIncompleteChunkedMessages()
void	resume()
void	seek(long timestamp)
void	seek(Function<String,Object> function)
void	seek(MessageId messageId)
CompletableFuture<Void>	seekAsync(long timestamp)
CompletableFuture<Void>	seekAsync(Function<String,Object> function)
CompletableFuture<Void>	seekAsync(MessageId messageId)
protected 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)
protected void	trackMessage(Message<?> msg)
protected void	trackMessage(MessageId messageId)
protected void	trackMessage(MessageId messageId, int redeliveryCount)
CompletableFuture<Void>	unsubscribeAsync()
protected void	updateAutoScaleReceiverQueueHint()

Methods inherited from class org.apache.pulsar.client.impl.ConsumerBase

acknowledge, acknowledge, acknowledge, acknowledge, acknowledgeAsync, acknowledgeAsync, acknowledgeAsync, acknowledgeAsync, acknowledgeAsync, acknowledgeAsync, acknowledgeAsync, acknowledgeCumulative, acknowledgeCumulative, acknowledgeCumulativeAsync, acknowledgeCumulativeAsync, acknowledgeCumulativeAsync, batchReceive, batchReceiveAsync, beforeConsume, callMessageListener, canEnqueueMessage, clearIncomingMessages, close, completePendingBatchReceive, completePendingReceive, decreaseIncomingMessageSize, doAcknowledgeWithTxn, doAcknowledgeWithTxn, enqueueMessageAndCheckBatchReceive, expectMoreIncomingMessages, failPendingReceive, getConsumerName, getCurrentReceiverQueueSize, getIncomingMessageSize, getLastMessageId, getLastMessageIds, getNewMessagesImpl, getSubscription, getSubType, getTopic, getTotalIncomingMessages, hasBatchReceiveTimeout, hasEnoughMessagesForBatchReceive, hasNextPendingReceive, hasPendingBatchReceive, initReceiverQueueSize, isValidConsumerEpoch, negativeAcknowledge, nextPendingReceive, notifyPendingBatchReceivedCallBack, notifyPendingBatchReceivedCallBack, onAcknowledge, onAcknowledge, onAcknowledgeCumulative, onAcknowledgeCumulative, onAckTimeoutSend, onNegativeAcksSend, onPartitionsChange, peekMessageKey, receive, receive, receiveAsync, reconsumeLater, reconsumeLater, reconsumeLater, reconsumeLaterAsync, reconsumeLaterAsync, reconsumeLaterAsync, reconsumeLaterCumulative, reconsumeLaterCumulativeAsync, reconsumeLaterCumulativeAsync, reduceCurrentReceiverQueueSize, resetIncomingMessageSize, subscribeFuture, toString, trackUnAckedMsgIfNoListener, triggerBatchReceiveTimeoutTask, tryTriggerListener, unsubscribe

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

lastDequeuedMessageId

protected volatile MessageId lastDequeuedMessageId

stats

protected final ConsumerStatsRecorder stats

paused

protected volatile boolean paused

chunkedMessagesMap

protected ConcurrentOpenHashMap<String,org.apache.pulsar.client.impl.ConsumerImpl.ChunkedMessageCtx> chunkedMessagesMap

expireTimeOfIncompleteChunkedMessageMillis

protected long expireTimeOfIncompleteChunkedMessageMillis

client

protected final PulsarClientImpl client

topic

protected final String topic

redirectedClusterURI

protected volatile URI redirectedClusterURI

Constructor Details

ConsumerImpl

protected ConsumerImpl(PulsarClientImpl client,
 String topic,
 ConsumerConfigurationData<T> conf,
 ExecutorProvider executorProvider,
 int partitionIndex,
 boolean hasParentConsumer,
 boolean parentConsumerHasListener,
 CompletableFuture<Consumer<T>> subscribeFuture,
 MessageId startMessageId,
 long startMessageRollbackDurationInSec,
 Schema<T> schema,
 ConsumerInterceptors<T> interceptors,
 boolean createTopicIfDoesNotExist)

Method Details

getConnectionHandler

public ConnectionHandler getConnectionHandler()

getUnAckedMessageTracker

public UnAckedMessageTracker getUnAckedMessageTracker()

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync()

Specified by:

unsubscribeAsync in interface Consumer<T>

Specified by:

unsubscribeAsync in class ConsumerBase<T>

minReceiverQueueSize

public int minReceiverQueueSize()

Specified by:

minReceiverQueueSize in class ConsumerBase<T>

internalReceive

protected Message<T> internalReceive()
                              throws PulsarClientException

Specified by:

internalReceive in class ConsumerBase<T>

Throws:

PulsarClientException

internalReceiveAsync

protected CompletableFuture<Message<T>> internalReceiveAsync()

Specified by:

internalReceiveAsync in class ConsumerBase<T>

internalReceive

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

Specified by:

internalReceive in class ConsumerBase<T>

Throws:

PulsarClientException

internalBatchReceive

protected Messages<T> internalBatchReceive()
                                    throws PulsarClientException

Specified by:

internalBatchReceive in class ConsumerBase<T>

Throws:

PulsarClientException

internalBatchReceiveAsync

protected CompletableFuture<Messages<T>> internalBatchReceiveAsync()

Specified by:

internalBatchReceiveAsync in class ConsumerBase<T>

doAcknowledge

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

Specified by:

doAcknowledge in class ConsumerBase<T>

doAcknowledge

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

Specified by:

doAcknowledge in class ConsumerBase<T>

doReconsumeLater

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

Specified by:

doReconsumeLater in class ConsumerBase<T>

negativeAcknowledge

public void negativeAcknowledge(MessageId messageId)

Specified by:

negativeAcknowledge in interface Consumer<T>

negativeAcknowledge

public void negativeAcknowledge(Message<?> message)

Specified by:

negativeAcknowledge in interface Consumer<T>

Overrides:

negativeAcknowledge in class ConsumerBase<T>

connectionOpened

public void connectionOpened(ClientCnx cnx)

consumerIsReconnectedToBroker

protected void consumerIsReconnectedToBroker(ClientCnx cnx,
 int currentQueueSize)

connectionFailed

public void connectionFailed(PulsarClientException exception)

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface Consumer<T>

Specified by:

closeAsync in class ConsumerBase<T>

isBatch

protected boolean isBatch(MessageMetadata messageMetadata)

newSingleMessage

protected <V> MessageImpl<V> newSingleMessage(int index,
 int numMessages,
 BrokerEntryMetadata brokerEntryMetadata,
 MessageMetadata msgMetadata,
 SingleMessageMetadata singleMessageMetadata,
 io.netty.buffer.ByteBuf payload,
 MessageIdImpl messageId,
 Schema<V> schema,
 boolean containMetadata,
 BitSetRecyclable ackBitSet,
 BitSet ackSetInMessageId,
 int redeliveryCount,
 long consumerEpoch)

newMessage

protected <V> MessageImpl<V> newMessage(MessageIdImpl messageId,
 BrokerEntryMetadata brokerEntryMetadata,
 MessageMetadata messageMetadata,
 io.netty.buffer.ByteBuf payload,
 Schema<V> schema,
 int redeliveryCount,
 long consumerEpoch)

messageProcessed

protected void messageProcessed(Message<?> msg)

Record the event that one message has been processed by the application. Periodically, it sends a Flow command to notify the broker that it can push more messages

Specified by:

messageProcessed in class ConsumerBase<T>

trackMessage

protected void trackMessage(Message<?> msg)

trackMessage

protected void trackMessage(MessageId messageId)

trackMessage

protected void trackMessage(MessageId messageId,
 int redeliveryCount)

increaseAvailablePermits

protected void increaseAvailablePermits(ClientCnx currentCnx,
 int delta)

increaseAvailablePermits

public void increaseAvailablePermits(int delta)

setCurrentReceiverQueueSize

protected void setCurrentReceiverQueueSize(int newSize)

Description copied from class: ConsumerBase

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

Specified by:

setCurrentReceiverQueueSize in class ConsumerBase<T>

Parameters:

newSize - new size of the receiver queue.

pause

public void pause()

Specified by:

pause in interface Consumer<T>

resume

public void resume()

Specified by:

resume in interface Consumer<T>

getLastDisconnectedTimestamp

public long getLastDisconnectedTimestamp()

Specified by:

getLastDisconnectedTimestamp in interface Consumer<T>

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Consumer<T>

isConnected

public boolean isConnected(ClientCnx cnx)

getAvailablePermits

public int getAvailablePermits()

Specified by:

getAvailablePermits in class ConsumerBase<T>

numMessagesInQueue

public int numMessagesInQueue()

Specified by:

numMessagesInQueue in class ConsumerBase<T>

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages()

Specified by:

redeliverUnacknowledgedMessages in interface Consumer<T>

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Set<MessageId> messageIds)

Description copied from class: ConsumerBase

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.

Specified by:

redeliverUnacknowledgedMessages in class ConsumerBase<T>

updateAutoScaleReceiverQueueHint

protected void updateAutoScaleReceiverQueueHint()

Specified by:

updateAutoScaleReceiverQueueHint in class ConsumerBase<T>

completeOpBatchReceive

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

Specified by:

completeOpBatchReceive in class ConsumerBase<T>

seek

public void seek(MessageId messageId)
          throws PulsarClientException

Specified by:

seek in interface Consumer<T>

Throws:

PulsarClientException

seek

public void seek(long timestamp)
          throws PulsarClientException

Specified by:

seek in interface Consumer<T>

Throws:

PulsarClientException

seek

public void seek(Function<String,Object> function)
          throws PulsarClientException

Specified by:

seek in interface Consumer<T>

Throws:

PulsarClientException

seekAsync

public CompletableFuture<Void> seekAsync(Function<String,Object> function)

Specified by:

seekAsync in interface Consumer<T>

seekAsync

public CompletableFuture<Void> seekAsync(long timestamp)

Specified by:

seekAsync in interface Consumer<T>

seekAsync

public CompletableFuture<Void> seekAsync(MessageId messageId)

Specified by:

seekAsync in interface Consumer<T>

hasMessageAvailable

public boolean hasMessageAvailable()
                            throws PulsarClientException

Throws:

PulsarClientException

hasMessageAvailableAsync

public CompletableFuture<Boolean> hasMessageAvailableAsync()

getLastMessageIdAsync

@Deprecated
public CompletableFuture<MessageId> getLastMessageIdAsync()

Deprecated.

Specified by:

getLastMessageIdAsync in interface Consumer<T>

Specified by:

getLastMessageIdAsync in class ConsumerBase<T>

getLastMessageIdsAsync

public CompletableFuture<List<TopicMessageId>> getLastMessageIdsAsync()

Specified by:

getLastMessageIdsAsync in interface Consumer<T>

internalGetLastMessageIdAsync

public CompletableFuture<org.apache.pulsar.client.impl.ConsumerImpl.GetLastMessageIdResponse> internalGetLastMessageIdAsync()

getStats

public ConsumerStatsRecorder getStats()

Specified by:

getStats in interface Consumer<T>

hasReachedEndOfTopic

public boolean hasReachedEndOfTopic()

Specified by:

hasReachedEndOfTopic in interface Consumer<T>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getClientCnx

public ClientCnx getClientCnx()

getTopicNameWithoutPartition

@Deprecated
public String getTopicNameWithoutPartition()

Deprecated.

removeExpireIncompleteChunkedMessages

protected void removeExpireIncompleteChunkedMessages()

getPossibleSendToDeadLetterTopicMessages

public Map<MessageIdAdv,List<MessageImpl<T>>> getPossibleSendToDeadLetterTopicMessages()

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