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>

Direct Known Subclasses:

ConsumerImpl, MultiTopicsConsumerImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
protected PulsarClientImpl	client
protected ConsumerConfigurationData<T>	conf
protected ConsumerEventListener	consumerEventListener
protected String	consumerName
protected ConsumerInterceptors<T>	interceptors
protected MessageListener<T>	listener
protected ExecutorService	listenerExecutor
protected int	maxReceiverQueueSize
protected ConcurrentLinkedQueue<CompletableFuture<Message<T>>>	pendingReceives
protected Schema<T>	schema
protected CompletableFuture<Consumer<T>>	subscribeFuture
protected String	subscription
protected String	topic

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	acknowledge(Message<?> message) Acknowledge the consumption of a single message
void	acknowledge(MessageId messageId) Acknowledge the consumption of a single message, identified by its MessageId
CompletableFuture<Void>	acknowledgeAsync(Message<?> message) Asynchronously acknowledge the consumption of a single message
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId) Asynchronously acknowledge the consumption of a single message
void	acknowledgeCumulative(Message<?> message) Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
void	acknowledgeCumulative(MessageId messageId) Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
CompletableFuture<Void>	acknowledgeCumulativeAsync(Message<?> message) Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
CompletableFuture<Void>	acknowledgeCumulativeAsync(MessageId messageId) Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
protected Message<T>	beforeConsume(Message<T> message)
protected boolean	changeToReadyState()
void	close() Close the consumer and stop the broker to push more messages.
abstract CompletableFuture<Void>	closeAsync() Asynchronously close the consumer and stop the broker to push more messages
protected abstract 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)
abstract int	getAvailablePermits()
PulsarClientImpl	getClient()
String	getConsumerName() Get the name of consumer.
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
String	getSubscription() Get a subscription for the consumer
protected PulsarApi.CommandSubscribe.SubType	getSubType()
String	getTopic() Get a topic for the consumer
protected abstract Message<T>	internalReceive()
protected abstract Message<T>	internalReceive(int timeout, TimeUnit unit)
protected abstract CompletableFuture<Message<T>>	internalReceiveAsync()
abstract int	numMessagesInQueue()
protected void	onAcknowledge(MessageId messageId, Throwable exception)
protected void	onAcknowledgeCumulative(MessageId messageId, Throwable exception)
Message<T>	receive() Receives a single message.
Message<T>	receive(int timeout, TimeUnit unit) Receive a single message
CompletableFuture<Message<T>>	receiveAsync() Receive a single message
protected abstract void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds) Redelivers the given unacknowledged messages.
protected void	setMaxReceiverQueueSize(int newSize)
protected void	setState(org.apache.pulsar.client.impl.HandlerState.State s)
CompletableFuture<Consumer<T>>	subscribeFuture()
String	toString()
void	unsubscribe() Unsubscribe the consumer
abstract CompletableFuture<Void>	unsubscribeAsync() Asynchronously unsubscribe the consumer

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

getStats, hasReachedEndOfTopic, isConnected, redeliverUnacknowledgedMessages, seek, seekAsync

Field Detail

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

listenerExecutor

protected final ExecutorService listenerExecutor

pendingReceives

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

maxReceiverQueueSize

protected int maxReceiverQueueSize

schema

protected Schema<T> schema

interceptors

protected final ConsumerInterceptors<T> interceptors

client

protected final PulsarClientImpl client

topic

protected final String topic

Constructor Detail

ConsumerBase

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

Method Detail

receive

public Message<T> receive()
                   throws PulsarClientException

Description copied from interface: Consumer

Receives a single message.

This calls blocks until a message is available.

Specified by:

receive in interface Consumer<T>

Returns:

the received message

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException.InvalidConfigurationException - if a message listener was defined in the configuration

PulsarClientException

receiveAsync

public CompletableFuture<Message<T>> receiveAsync()

Description copied from interface: Consumer

Receive a single message

Retrieves a message when it will be available and completes CompletableFuture with received message.

receiveAsync() should be called subsequently once returned CompletableFuture gets complete with received message. Else it creates backlog of receive requests in the application.

Specified by:

receiveAsync in interface Consumer<T>

Returns:

CompletableFuture<Message> will be completed when message is available

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

Description copied from interface: Consumer

Receive a single message

Retrieves a message, waiting up to the specified wait time if necessary.

Specified by:

receive in interface Consumer<T>

Parameters:

timeout - 0 or less means immediate rather than infinite

Returns:

the received Message or null if no message available before timeout

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException.InvalidConfigurationException - if a message listener was defined in the configuration

PulsarClientException

internalReceive

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

Throws:

PulsarClientException

acknowledge

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

Description copied from interface: Consumer

Acknowledge the consumption of a single message

Specified by:

acknowledge in interface Consumer<T>

Parameters:

message - The Message to be acknowledged

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException

acknowledge

public void acknowledge(MessageId messageId)
                 throws PulsarClientException

Description copied from interface: Consumer

Acknowledge the consumption of a single message, identified by its MessageId

Specified by:

acknowledge in interface Consumer<T>

Parameters:

messageId - The MessageId to be acknowledged

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException

acknowledgeCumulative

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

Description copied from interface: Consumer

Acknowledge the reception of all the messages in the stream up to (and including) the provided message. This method will block until the acknowledge has been sent to the broker. After that, the messages will not be re-delivered to this consumer. Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared. It's equivalent to calling asyncAcknowledgeCumulative(Message) and waiting for the callback to be triggered.

Specified by:

acknowledgeCumulative in interface Consumer<T>

Parameters:

message - The Message to be cumulatively acknowledged

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException

acknowledgeCumulative

public void acknowledgeCumulative(MessageId messageId)
                           throws PulsarClientException

Description copied from interface: Consumer

Acknowledge the reception of all the messages in the stream up to (and including) the provided message. This method will block until the acknowledge has been sent to the broker. After that, the messages will not be re-delivered to this consumer. Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared. It's equivalent to calling asyncAcknowledgeCumulative(MessageId) and waiting for the callback to be triggered.

Specified by:

acknowledgeCumulative in interface Consumer<T>

Parameters:

messageId - The MessageId to be cumulatively acknowledged

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException

acknowledgeAsync

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

Description copied from interface: Consumer

Asynchronously acknowledge the consumption of a single message

Specified by:

acknowledgeAsync in interface Consumer<T>

Parameters:

message - The Message to be acknowledged

Returns:

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

acknowledgeCumulativeAsync

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

Description copied from interface: Consumer

Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message. Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.

Specified by:

acknowledgeCumulativeAsync in interface Consumer<T>

Parameters:

message - The Message to be cumulatively acknowledged

Returns:

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

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(MessageId messageId)

Description copied from interface: Consumer

Asynchronously acknowledge the consumption of a single message

Specified by:

acknowledgeAsync in interface Consumer<T>

Parameters:

messageId - The MessageId to be acknowledged

Returns:

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

acknowledgeCumulativeAsync

public CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId)

Description copied from interface: Consumer

Asynchronously Acknowledge the reception of all the messages in the stream up to (and including) the provided message. Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.

Specified by:

acknowledgeCumulativeAsync in interface Consumer<T>

Parameters:

messageId - The MessageId to be cumulatively acknowledged

Returns:

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

doAcknowledge

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

unsubscribe

public void unsubscribe()
                 throws PulsarClientException

Description copied from interface: Consumer

Unsubscribe the consumer

This call blocks until the consumer is unsubscribed.

Specified by:

unsubscribe in interface Consumer<T>

Throws:

PulsarClientException

unsubscribeAsync

public abstract CompletableFuture<Void> unsubscribeAsync()

Description copied from interface: Consumer

Asynchronously unsubscribe the consumer

Specified by:

unsubscribeAsync in interface Consumer<T>

Returns:

CompletableFuture for this operation

close

public void close()
           throws PulsarClientException

Description copied from interface: Consumer

Close the consumer and stop the broker to push more messages.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Consumer<T>

Throws:

PulsarClientException

closeAsync

public abstract 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>

Returns:

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

getSubType

protected PulsarApi.CommandSubscribe.SubType getSubType()

getAvailablePermits

public abstract int getAvailablePermits()

numMessagesInQueue

public abstract int numMessagesInQueue()

subscribeFuture

public CompletableFuture<Consumer<T>> subscribeFuture()

getTopic

public String getTopic()

Description copied from interface: Consumer

Get a topic for the consumer

Specified by:

getTopic in interface Consumer<T>

Returns:

topic for the consumer

getSubscription

public String getSubscription()

Description copied from interface: Consumer

Get a subscription for the consumer

Specified by:

getSubscription in interface Consumer<T>

Returns:

subscription for the consumer

getConsumerName

public String getConsumerName()

Description copied from interface: Consumer

Get the name of consumer.

Specified by:

getConsumerName in interface Consumer<T>

Returns:

consumer name.

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

setMaxReceiverQueueSize

protected void setMaxReceiverQueueSize(int newSize)

beforeConsume

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

onAcknowledge

protected void onAcknowledge(MessageId messageId,
                             Throwable exception)

onAcknowledgeCumulative

protected void onAcknowledgeCumulative(MessageId messageId,
                                       Throwable exception)

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