org.apache.pulsar.client.impl

Class ConsumerBase<T>

java.lang.Object

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

All Implemented Interfaces:

io.netty.util.TimerTask, Closeable, AutoCloseable, Consumer<T>

Direct Known Subclasses:

ConsumerImpl, MultiTopicsConsumerImpl

public abstract class ConsumerBase<T>
extends Object
implements io.netty.util.TimerTask, Consumer<T>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchReceivePolicy	batchReceivePolicy
protected io.netty.util.Timeout	batchReceiveTimeout
protected PulsarClientImpl	client
protected ConsumerConfigurationData<T>	conf
protected ConsumerEventListener	consumerEventListener
protected String	consumerName
protected static AtomicLongFieldUpdater<ConsumerBase>	INCOMING_MESSAGES_SIZE_UPDATER
protected long	incomingMessagesSize
protected ConsumerInterceptors<T>	interceptors
protected MessageListener<T>	listener
protected ExecutorService	listenerExecutor
protected int	maxReceiverQueueSize
protected ConcurrentLinkedQueue<ConsumerBase.OpBatchReceive<T>>	pendingBatchReceives
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)
void	acknowledge(MessageId messageId)
void	acknowledge(Messages<?> messages)
CompletableFuture<Void>	acknowledgeAsync(Message<?> message)
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId)
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId, Transaction txn)
CompletableFuture<Void>	acknowledgeAsync(Messages<?> messages)
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 boolean	canEnqueueMessage(Message<T> message)
protected boolean	changeToReadyState()
protected boolean	changeToRegisteringSchemaState()
void	close()
abstract CompletableFuture<Void>	closeAsync()
protected abstract void	completeOpBatchReceive(ConsumerBase.OpBatchReceive<T> op)
protected abstract CompletableFuture<Void>	doAcknowledge(MessageId messageId, PulsarApi.CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected CompletableFuture<Void>	doAcknowledgeWithTxn(MessageId messageId, PulsarApi.CommandAck.AckType ackType, Map<String,Long> properties, TransactionImpl txn)
protected boolean	enqueueMessageAndCheckBatchReceive(Message<T> message)
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()
MessageId	getLastMessageId()
abstract CompletableFuture<MessageId>	getLastMessageIdAsync()
protected MessagesImpl<T>	getNewMessagesImpl()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
String	getSubscription()
protected PulsarApi.CommandSubscribe.SubType	getSubType()
String	getTopic()
protected boolean	hasEnoughMessagesForBatchReceive()
protected boolean	hasPendingBatchReceive()
protected abstract Messages<T>	internalBatchReceive()
protected abstract CompletableFuture<Messages<T>>	internalBatchReceiveAsync()
protected abstract Message<T>	internalReceive()
protected abstract Message<T>	internalReceive(int timeout, TimeUnit unit)
protected abstract CompletableFuture<Message<T>>	internalReceiveAsync()
protected abstract void	messageProcessed(Message<?> msg)
void	negativeAcknowledge(Message<?> message)
void	negativeAcknowledge(Messages<?> messages)
protected void	notifyPendingBatchReceivedCallBack()
protected void	notifyPendingBatchReceivedCallBack(ConsumerBase.OpBatchReceive<T> opBatchReceive)
abstract int	numMessagesInQueue()
protected void	onAcknowledge(MessageId messageId, Throwable exception)
protected void	onAcknowledgeCumulative(MessageId messageId, Throwable exception)
protected void	onAckTimeoutSend(Set<MessageId> messageIds)
protected void	onNegativeAcksSend(Set<MessageId> messageIds)
Message<T>	receive()
Message<T>	receive(int timeout, TimeUnit unit)
CompletableFuture<Message<T>>	receiveAsync()
protected abstract void	redeliverUnacknowledgedMessages(Set<MessageId> messageIds) Redelivers the given unacknowledged messages.
void	run(io.netty.util.Timeout timeout)
protected void	setMaxReceiverQueueSize(int newSize)
protected void	setState(org.apache.pulsar.client.impl.HandlerState.State s)
CompletableFuture<Consumer<T>>	subscribeFuture()
String	toString()
void	unsubscribe()
abstract CompletableFuture<Void>	unsubscribeAsync()

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, negativeAcknowledge, pause, redeliverUnacknowledgedMessages, resume, seek, seek, seekAsync, 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 final Schema<T> schema

interceptors

protected final ConsumerInterceptors<T> interceptors

batchReceivePolicy

protected final BatchReceivePolicy batchReceivePolicy

pendingBatchReceives

protected ConcurrentLinkedQueue<ConsumerBase.OpBatchReceive<T>> pendingBatchReceives

INCOMING_MESSAGES_SIZE_UPDATER

protected static final AtomicLongFieldUpdater<ConsumerBase> INCOMING_MESSAGES_SIZE_UPDATER

incomingMessagesSize

protected volatile long incomingMessagesSize

batchReceiveTimeout

protected volatile io.netty.util.Timeout batchReceiveTimeout

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

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

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 Consumer<T>

Throws:

PulsarClientException

acknowledge

public void acknowledge(MessageId messageId)
                 throws PulsarClientException

Specified by:

acknowledge in interface Consumer<T>

Throws:

PulsarClientException

acknowledge

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

Specified by:

acknowledge in interface Consumer<T>

Throws:

PulsarClientException

acknowledgeCumulative

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

Specified by:

acknowledgeCumulative in interface Consumer<T>

Throws:

PulsarClientException

acknowledgeCumulative

public void acknowledgeCumulative(MessageId messageId)
                           throws PulsarClientException

Specified by:

acknowledgeCumulative in interface Consumer<T>

Throws:

PulsarClientException

acknowledgeAsync

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

Specified by:

acknowledgeAsync in interface Consumer<T>

acknowledgeAsync

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

Specified by:

acknowledgeAsync in interface Consumer<T>

acknowledgeCumulativeAsync

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

Specified by:

acknowledgeCumulativeAsync in interface Consumer<T>

acknowledgeAsync

public CompletableFuture<Void> acknowledgeAsync(MessageId messageId)

Specified by:

acknowledgeAsync in interface Consumer<T>

acknowledgeAsync

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

acknowledgeCumulativeAsync

public CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId)

Specified by:

acknowledgeCumulativeAsync in interface Consumer<T>

acknowledgeCumulativeAsync

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

negativeAcknowledge

public void negativeAcknowledge(Message<?> message)

Specified by:

negativeAcknowledge in interface Consumer<T>

doAcknowledgeWithTxn

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

doAcknowledge

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

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

unsubscribeAsync

public abstract CompletableFuture<Void> unsubscribeAsync()

Specified by:

unsubscribeAsync in interface Consumer<T>

close

public void close()
           throws PulsarClientException

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

Specified by:

closeAsync in interface Consumer<T>

getLastMessageId

public MessageId getLastMessageId()
                           throws PulsarClientException

Specified by:

getLastMessageId in interface Consumer<T>

Throws:

PulsarClientException

getLastMessageIdAsync

public abstract CompletableFuture<MessageId> getLastMessageIdAsync()

Specified by:

getLastMessageIdAsync in interface Consumer<T>

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

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

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)

onNegativeAcksSend

protected void onNegativeAcksSend(Set<MessageId> messageIds)

onAckTimeoutSend

protected void onAckTimeoutSend(Set<MessageId> messageIds)

canEnqueueMessage

protected boolean canEnqueueMessage(Message<T> message)

enqueueMessageAndCheckBatchReceive

protected boolean enqueueMessageAndCheckBatchReceive(Message<T> message)

hasEnoughMessagesForBatchReceive

protected boolean hasEnoughMessagesForBatchReceive()

notifyPendingBatchReceivedCallBack

protected void notifyPendingBatchReceivedCallBack()

notifyPendingBatchReceivedCallBack

protected void notifyPendingBatchReceivedCallBack(ConsumerBase.OpBatchReceive<T> opBatchReceive)

messageProcessed

protected abstract void messageProcessed(Message<?> msg)

run

public void run(io.netty.util.Timeout timeout)
         throws Exception

Specified by:

run in interface io.netty.util.TimerTask

Throws:

Exception

getNewMessagesImpl

protected MessagesImpl<T> getNewMessagesImpl()

hasPendingBatchReceive

protected boolean hasPendingBatchReceive()

completeOpBatchReceive

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

changeToReadyState

protected boolean changeToReadyState()

changeToRegisteringSchemaState

protected boolean changeToRegisteringSchemaState()

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