Package org.apache.pulsar.client.impl

Class MultiTopicsConsumerImpl<T>

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<T>, MessageAcknowledger

Direct Known Subclasses:

PatternMultiTopicsConsumerImpl

public class MultiTopicsConsumerImpl<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 final PulsarClientImpl	client
static final String	DUMMY_TOPIC_NAME_PREFIX
protected final ConcurrentHashMap<String,Integer>	partitionedTopics
protected URI	redirectedClusterURI
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, MESSAGE_LISTENER_QUEUE_SIZE_UPDATER, messageListenerQueueSize, pendingBatchReceives, pendingReceives, scaleReceiverQueueHint, schema, subscribeFuture, subscription, unAckedChunkedMessageIdSequenceMap, unAckedMessageTracker

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)
static <T> MultiTopicsConsumerImpl<T>	createPartitionedConsumer(PulsarClientImpl client, ConsumerConfigurationData<T> conf, ExecutorProvider executorProvider, CompletableFuture<Consumer<T>> subscribeFuture, int numPartitions, Schema<T> schema, ConsumerInterceptors<T> interceptors)
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 txnImpl)
protected CompletableFuture<Void>	doReconsumeLater(Message<?> message, CommandAck.AckType ackType, Map<String,String> customProperties, long delayTime, TimeUnit unit)
protected org.apache.pulsar.client.impl.HandlerState.State	getAndUpdateState(UnaryOperator<org.apache.pulsar.client.impl.HandlerState.State> updater)
int	getAvailablePermits()
PulsarClientImpl	getClient()
List<ConsumerImpl<T>>	getConsumers()
long	getLastDisconnectedTimestamp()
CompletableFuture<MessageId>	getLastMessageIdAsync()	Deprecated.
CompletableFuture<List<TopicMessageId>>	getLastMessageIdsAsync()
List<String>	getPartitionedTopics()
List<String>	getPartitions()
io.netty.util.Timeout	getPartitionsAutoUpdateTimeout()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
ConsumerStats	getStats()
UnAckedMessageTracker	getUnAckedMessageTracker()
boolean	hasMessageAvailable()
CompletableFuture<Boolean>	hasMessageAvailableAsync()
boolean	hasReachedEndOfTopic()
protected Messages<T>	internalBatchReceive()
protected CompletableFuture<Messages<T>>	internalBatchReceiveAsync()
protected Message<T>	internalReceive()
protected Message<T>	internalReceive(long timeout, TimeUnit unit)
protected CompletableFuture<Message<T>>	internalReceiveAsync()
boolean	isConnected()
static boolean	isIllegalMultiTopicsMessageId(MessageId messageId)
protected void	messageProcessed(Message<?> msg)
int	minReceiverQueueSize()
void	negativeAcknowledge(Message<?> message)
void	negativeAcknowledge(MessageId messageId)
int	numMessagesInQueue()
void	pause()
void	redeliverUnacknowledgedMessages()
void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds)	Redelivers the given unacknowledged messages.
CompletableFuture<Void>	removeConsumerAsync(String topicName)	Remove a consumer for a topic.
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)
CompletableFuture<Void>	subscribeAsync(String topicName, boolean createTopicIfDoesNotExist)	Subscribe one more given topic.
void	tryAcknowledgeMessage(Message<T> msg)
CompletableFuture<Void>	unsubscribeAsync(boolean force)
CompletableFuture<Void>	unsubscribeAsync(String topicName)
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, isSingleMessageAcked, 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, unsubscribe, unsubscribeAsync

Methods inherited from class java.lang.Object

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

Field Details

DUMMY_TOPIC_NAME_PREFIX

public static final String DUMMY_TOPIC_NAME_PREFIX

See Also:

• Constant Field Values

partitionedTopics

protected final ConcurrentHashMap<String,Integer> partitionedTopics

client

protected final PulsarClientImpl client

topic

protected final String topic

redirectedClusterURI

protected volatile URI redirectedClusterURI

Method Details

messageProcessed

protected void messageProcessed(Message<?> msg)

Specified by:

messageProcessed 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

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>

internalReceiveAsync

protected CompletableFuture<Message<T>> internalReceiveAsync()

Specified by:

internalReceiveAsync in class ConsumerBase<T>

doAcknowledge

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

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)

negativeAcknowledge

public void negativeAcknowledge(Message<?> message)

Specified by:

negativeAcknowledge in interface Consumer<T>

Overrides:

negativeAcknowledge in class ConsumerBase<T>

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync(boolean force)

Specified by:

unsubscribeAsync in interface Consumer<T>

Specified by:

unsubscribeAsync in class ConsumerBase<T>

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface Consumer<T>

Specified by:

closeAsync in class ConsumerBase<T>

isConnected

public boolean isConnected()

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages()

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

Throws:

PulsarClientException

seek

public void seek(long timestamp)
          throws PulsarClientException

Throws:

PulsarClientException

seek

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

Throws:

PulsarClientException

seekAsync

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

seekAsync

public CompletableFuture<Void> seekAsync(MessageId messageId)

seekAsync

public CompletableFuture<Void> seekAsync(long timestamp)

getAvailablePermits

public int getAvailablePermits()

Specified by:

getAvailablePermits in class ConsumerBase<T>

hasReachedEndOfTopic

public boolean hasReachedEndOfTopic()

hasMessageAvailable

public boolean hasMessageAvailable()
                            throws PulsarClientException

Throws:

PulsarClientException

hasMessageAvailableAsync

public CompletableFuture<Boolean> hasMessageAvailableAsync()

numMessagesInQueue

public int numMessagesInQueue()

Specified by:

numMessagesInQueue in class ConsumerBase<T>

getStats

public ConsumerStats getStats()

getUnAckedMessageTracker

public UnAckedMessageTracker getUnAckedMessageTracker()

Overrides:

getUnAckedMessageTracker in class ConsumerBase<T>

subscribeAsync

public CompletableFuture<Void> subscribeAsync(String topicName,
 boolean createTopicIfDoesNotExist)

Subscribe one more given topic.

Parameters:

topicName - topic name without the partition suffix.

createPartitionedConsumer

public static <T> MultiTopicsConsumerImpl<T> createPartitionedConsumer(PulsarClientImpl client,
 ConsumerConfigurationData<T> conf,
 ExecutorProvider executorProvider,
 CompletableFuture<Consumer<T>> subscribeFuture,
 int numPartitions,
 Schema<T> schema,
 ConsumerInterceptors<T> interceptors)

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync(String topicName)

removeConsumerAsync

public CompletableFuture<Void> removeConsumerAsync(String topicName)

Remove a consumer for a topic.

Parameters:

topicName - topic name contains the partition suffix.

getPartitionedTopics

public List<String> getPartitionedTopics()

getPartitions

public List<String> getPartitions()

getConsumers

public List<ConsumerImpl<T>> getConsumers()

pause

public void pause()

resume

public void resume()

getLastDisconnectedTimestamp

public long getLastDisconnectedTimestamp()

getPartitionsAutoUpdateTimeout

public io.netty.util.Timeout getPartitionsAutoUpdateTimeout()

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

isIllegalMultiTopicsMessageId

public static boolean isIllegalMultiTopicsMessageId(MessageId messageId)

tryAcknowledgeMessage

public void tryAcknowledgeMessage(Message<T> msg)

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.

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