程序包 org.apache.pulsar.client.impl

类 ConsumerImpl<T>

java.lang.Object

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

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

所有已实现的接口:

Closeable, AutoCloseable, Consumer<T>, MessageAcknowledger

直接已知子类:

ZeroQueueConsumerImpl

public class ConsumerImpl<T>
extends ConsumerBase<T>

嵌套类概要

从类继承的嵌套类/接口 org.apache.pulsar.client.impl.ConsumerBase

ConsumerBase.OpBatchReceive<T>

字段概要

字段

修饰符和类型	字段	说明
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

从类继承的字段 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

构造器概要

构造器

限定符	构造器	说明
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)

方法概要

修饰符和类型	方法	说明
protected boolean	changeToConnecting()
protected boolean	changeToReadyState()
protected boolean	changeToRegisteringSchemaState()
CompletableFuture<Void>	closeAsync()
protected void	completeOpBatchReceive(ConsumerBase.OpBatchReceive<T> op)
void	connectionFailed(PulsarClientException exception)
CompletableFuture<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()	已过时。
CompletableFuture<List<TopicMessageId>>	getLastMessageIdsAsync()
Map<MessageIdAdv,List<MessageImpl<T>>>	getPossibleSendToDeadLetterTopicMessages()
protected org.apache.pulsar.client.impl.HandlerState.State	getState()
ConsumerStatsRecorder	getStats()
String	getTopicNameWithoutPartition()	已过时。
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(boolean force)
protected void	updateAutoScaleReceiverQueueHint()

从类继承的方法 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

从类继承的方法 java.lang.Object

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

字段详细资料

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

构造器详细资料

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)

方法详细资料

getConnectionHandler

public ConnectionHandler getConnectionHandler()

getUnAckedMessageTracker

public UnAckedMessageTracker getUnAckedMessageTracker()

覆盖:

getUnAckedMessageTracker 在类中 ConsumerBase<T>

unsubscribeAsync

public CompletableFuture<Void> unsubscribeAsync(boolean force)

指定者:

unsubscribeAsync 在接口中 Consumer<T>

指定者:

unsubscribeAsync 在类中 ConsumerBase<T>

minReceiverQueueSize

public int minReceiverQueueSize()

指定者:

minReceiverQueueSize 在类中 ConsumerBase<T>

internalReceive

protected Message<T> internalReceive()
                              throws PulsarClientException

指定者:

internalReceive 在类中 ConsumerBase<T>

抛出:

PulsarClientException

internalReceiveAsync

protected CompletableFuture<Message<T>> internalReceiveAsync()

指定者:

internalReceiveAsync 在类中 ConsumerBase<T>

internalReceive

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

指定者:

internalReceive 在类中 ConsumerBase<T>

抛出:

PulsarClientException

internalBatchReceive

protected Messages<T> internalBatchReceive()
                                    throws PulsarClientException

指定者:

internalBatchReceive 在类中 ConsumerBase<T>

抛出:

PulsarClientException

internalBatchReceiveAsync

protected CompletableFuture<Messages<T>> internalBatchReceiveAsync()

指定者:

internalBatchReceiveAsync 在类中 ConsumerBase<T>

doAcknowledge

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

指定者:

doAcknowledge 在类中 ConsumerBase<T>

doAcknowledge

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

指定者:

doAcknowledge 在类中 ConsumerBase<T>

doReconsumeLater

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

指定者:

doReconsumeLater 在类中 ConsumerBase<T>

negativeAcknowledge

public void negativeAcknowledge(MessageId messageId)

指定者:

negativeAcknowledge 在接口中 Consumer<T>

negativeAcknowledge

public void negativeAcknowledge(Message<?> message)

指定者:

negativeAcknowledge 在接口中 Consumer<T>

覆盖:

negativeAcknowledge 在类中 ConsumerBase<T>

connectionOpened

public CompletableFuture<Void> connectionOpened(ClientCnx cnx)

consumerIsReconnectedToBroker

protected void consumerIsReconnectedToBroker(ClientCnx cnx,
 int currentQueueSize)

connectionFailed

public void connectionFailed(PulsarClientException exception)

closeAsync

public CompletableFuture<Void> closeAsync()

指定者:

closeAsync 在接口中 Consumer<T>

指定者:

closeAsync 在类中 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

指定者:

messageProcessed 在类中 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)

从类复制的说明: ConsumerBase

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

指定者:

setCurrentReceiverQueueSize 在类中 ConsumerBase<T>

参数:

newSize - new size of the receiver queue.

pause

public void pause()

指定者:

pause 在接口中 Consumer<T>

resume

public void resume()

指定者:

resume 在接口中 Consumer<T>

getLastDisconnectedTimestamp

public long getLastDisconnectedTimestamp()

指定者:

getLastDisconnectedTimestamp 在接口中 Consumer<T>

isConnected

public boolean isConnected()

指定者:

isConnected 在接口中 Consumer<T>

isConnected

public boolean isConnected(ClientCnx cnx)

getAvailablePermits

public int getAvailablePermits()

指定者:

getAvailablePermits 在类中 ConsumerBase<T>

numMessagesInQueue

public int numMessagesInQueue()

指定者:

numMessagesInQueue 在类中 ConsumerBase<T>

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages()

指定者:

redeliverUnacknowledgedMessages 在接口中 Consumer<T>

redeliverUnacknowledgedMessages

public void redeliverUnacknowledgedMessages(Set<MessageId> messageIds)

从类复制的说明: 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.

指定者:

redeliverUnacknowledgedMessages 在类中 ConsumerBase<T>

updateAutoScaleReceiverQueueHint

protected void updateAutoScaleReceiverQueueHint()

指定者:

updateAutoScaleReceiverQueueHint 在类中 ConsumerBase<T>

completeOpBatchReceive

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

指定者:

completeOpBatchReceive 在类中 ConsumerBase<T>

seek

public void seek(MessageId messageId)
          throws PulsarClientException

指定者:

seek 在接口中 Consumer<T>

抛出:

PulsarClientException

seek

public void seek(long timestamp)
          throws PulsarClientException

指定者:

seek 在接口中 Consumer<T>

抛出:

PulsarClientException

seek

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

指定者:

seek 在接口中 Consumer<T>

抛出:

PulsarClientException

seekAsync

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

指定者:

seekAsync 在接口中 Consumer<T>

seekAsync

public CompletableFuture<Void> seekAsync(long timestamp)

指定者:

seekAsync 在接口中 Consumer<T>

seekAsync

public CompletableFuture<Void> seekAsync(MessageId messageId)

指定者:

seekAsync 在接口中 Consumer<T>

hasMessageAvailable

public boolean hasMessageAvailable()
                            throws PulsarClientException

抛出:

PulsarClientException

hasMessageAvailableAsync

public CompletableFuture<Boolean> hasMessageAvailableAsync()

getLastMessageIdAsync

@Deprecated
public CompletableFuture<MessageId> getLastMessageIdAsync()

已过时。

指定者:

getLastMessageIdAsync 在接口中 Consumer<T>

指定者:

getLastMessageIdAsync 在类中 ConsumerBase<T>

getLastMessageIdsAsync

public CompletableFuture<List<TopicMessageId>> getLastMessageIdsAsync()

指定者:

getLastMessageIdsAsync 在接口中 Consumer<T>

internalGetLastMessageIdAsync

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

getStats

public ConsumerStatsRecorder getStats()

指定者:

getStats 在接口中 Consumer<T>

hasReachedEndOfTopic

public boolean hasReachedEndOfTopic()

指定者:

hasReachedEndOfTopic 在接口中 Consumer<T>

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

getClientCnx

public ClientCnx getClientCnx()

getTopicNameWithoutPartition

@Deprecated
public String getTopicNameWithoutPartition()

已过时。

removeExpireIncompleteChunkedMessages

protected void removeExpireIncompleteChunkedMessages()

getPossibleSendToDeadLetterTopicMessages

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

setRedirectedClusterURI

protected void setRedirectedClusterURI(String serviceUrl,
 String serviceUrlTls)
                                throws URISyntaxException

抛出:

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