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>

Direct Known Subclasses:

PatternMultiTopicsConsumerImpl

public class MultiTopicsConsumerImpl<T>
extends ConsumerBase<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected PulsarClientImpl	client
protected NamespaceName	namespaceName
protected String	topic
protected ConcurrentHashMap<String,Integer>	topics

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

conf, consumerEventListener, consumerName, interceptors, listener, listenerExecutor, maxReceiverQueueSize, pendingReceives, schema, subscribeFuture, subscription

Method Summary

Modifier and Type	Method and Description
protected boolean	changeToReadyState()
CompletableFuture<Void>	closeAsync() Asynchronously close the consumer and stop the broker to push more messages
static <T> MultiTopicsConsumerImpl<T>	createPartitionedConsumer(PulsarClientImpl client, ConsumerConfigurationData<T> conf, ExecutorService listenerExecutor, CompletableFuture<Consumer<T>> subscribeFuture, int numPartitions, Schema<T> schema, ConsumerInterceptors<T> interceptors)
protected CompletableFuture<Void>	doAcknowledge(MessageId messageId, PulsarApi.CommandAck.AckType ackType, Map<String,Long> properties)
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()
List<String>	getPartitionedTopics()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
ConsumerStats	getStats() Get statistics for the consumer.
List<String>	getTopics()
UnAckedMessageTracker	getUnAckedMessageTracker()
boolean	hasReachedEndOfTopic() Return true if the topic was terminated and this consumer has already consumed all the messages in the topic.
protected Message<T>	internalReceive()
protected Message<T>	internalReceive(int timeout, TimeUnit unit)
protected CompletableFuture<Message<T>>	internalReceiveAsync()
boolean	isConnected()
int	numMessagesInQueue()
void	redeliverUnacknowledgedMessages() Redelivers all the unacknowledged messages.
void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds) Redelivers the given unacknowledged messages.
void	seek(MessageId messageId) Reset the subscription associated with this consumer to a specific message id.
CompletableFuture<Void>	seekAsync(MessageId messageId) Reset the subscription associated with this consumer to a specific message id.
protected void	setState(org.apache.pulsar.client.impl.HandlerState.State s)
CompletableFuture<Void>	subscribeAsync(String topicName)
CompletableFuture<Void>	unsubscribeAsync() Asynchronously unsubscribe the consumer
CompletableFuture<Void>	unsubscribeAsync(String topicName)

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

acknowledge, acknowledge, acknowledgeAsync, acknowledgeAsync, acknowledgeCumulative, acknowledgeCumulative, acknowledgeCumulativeAsync, acknowledgeCumulativeAsync, beforeConsume, close, getConsumerName, getSubscription, getSubType, getTopic, onAcknowledge, onAcknowledgeCumulative, receive, receive, receiveAsync, setMaxReceiverQueueSize, subscribeFuture, toString, unsubscribe

Methods inherited from class java.lang.Object

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

Field Detail

namespaceName

protected NamespaceName namespaceName

topics

protected final ConcurrentHashMap<String,Integer> topics

client

protected final PulsarClientImpl client

topic

protected final String topic

Method Detail

internalReceive

protected Message<T> internalReceive()
                              throws PulsarClientException

Specified by:

internalReceive in class ConsumerBase<T>

Throws:

PulsarClientException

internalReceive

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

Specified by:

internalReceive in class ConsumerBase<T>

Throws:

PulsarClientException

internalReceiveAsync

protected CompletableFuture<Message<T>> internalReceiveAsync()

Specified by:

internalReceiveAsync in class ConsumerBase<T>

doAcknowledge

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

Specified by:

doAcknowledge in class ConsumerBase<T>

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync()

Description copied from interface: Consumer

Asynchronously unsubscribe the consumer

Specified by:

unsubscribeAsync in interface Consumer<T>

Specified by:

unsubscribeAsync in class ConsumerBase<T>

Returns:

CompletableFuture for this operation

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: Consumer

Asynchronously close the consumer and stop the broker to push more messages

Specified by:

closeAsync in interface Consumer<T>

Specified by:

closeAsync in class ConsumerBase<T>

Returns:

a future that can be used to track the completion of the operation

isConnected

public boolean isConnected()

Returns:

Whether the consumer is connected to the broker

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages()

Description copied from interface: Consumer

Redelivers all the 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.

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>

seek

public void seek(MessageId messageId)
          throws PulsarClientException

Description copied from interface: Consumer

Reset the subscription associated with this consumer to a specific message id.

The message id can either be a specific message or represent the first or last messages in the topic.

• MessageId.earliest : Reset the subscription on the earliest message available in the topic
• MessageId.latest : Reset the subscription on the latest message in the topic

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

Parameters:

messageId - the message id where to reposition the subscription

Throws:

PulsarClientException

seekAsync

public CompletableFuture<Void> seekAsync(MessageId messageId)

Description copied from interface: Consumer

Reset the subscription associated with this consumer to a specific message id.

The message id can either be a specific message or represent the first or last messages in the topic.

• MessageId.earliest : Reset the subscription on the earliest message available in the topic
• MessageId.latest : Reset the subscription on the latest message in the topic

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

Parameters:

messageId - the message id where to reposition the subscription

Returns:

a future to track the completion of the seek operation

getAvailablePermits

public int getAvailablePermits()

Specified by:

getAvailablePermits in class ConsumerBase<T>

hasReachedEndOfTopic

public boolean hasReachedEndOfTopic()

Description copied from interface: Consumer

Return true if the topic was terminated and this consumer has already consumed all the messages in the topic. Please note that this does not simply mean that the consumer is caught up with the last message published by producers, rather the topic needs to be explicitly "terminated".

numMessagesInQueue

public int numMessagesInQueue()

Specified by:

numMessagesInQueue in class ConsumerBase<T>

getStats

public ConsumerStats getStats()

Description copied from interface: Consumer

Get statistics for the consumer.

• numMsgsReceived : Number of messages received in the current interval
• numBytesReceived : Number of bytes received in the current interval
• numReceiveFailed : Number of messages failed to receive in the current interval
• numAcksSent : Number of acks sent in the current interval
• numAcksFailed : Number of acks failed to send in the current interval
• totalMsgsReceived : Total number of messages received
• totalBytesReceived : Total number of bytes received
• totalReceiveFailed : Total number of messages failed to receive
• totalAcksSent : Total number of acks sent
• totalAcksFailed : Total number of acks failed to sent

Returns:

statistic for the consumer

getUnAckedMessageTracker

public UnAckedMessageTracker getUnAckedMessageTracker()

subscribeAsync

public CompletableFuture<Void> subscribeAsync(String topicName)

createPartitionedConsumer

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

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync(String topicName)

getTopics

public List<String> getTopics()

getPartitionedTopics

public List<String> getPartitionedTopics()

getConsumers

public List<ConsumerImpl<T>> getConsumers()

changeToReadyState

protected boolean changeToReadyState()

getState

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

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