com.alibaba.rocketmq.client.consumer

类 DefaultMQPullConsumer

java.lang.Object

com.alibaba.rocketmq.client.ClientConfig

com.alibaba.rocketmq.client.consumer.DefaultMQPullConsumer

所有已实现的接口:

MQConsumer, MQPullConsumer, MQAdmin

public class DefaultMQPullConsumer
extends ClientConfig
implements MQPullConsumer

Default pulling consumer

从以下版本开始:

2013-7-24

作者:

shijia.wxr

字段概要

字段

限定符和类型	字段和说明
protected DefaultMQPullConsumerImpl	defaultMQPullConsumerImpl

从类继承的字段 com.alibaba.rocketmq.client.ClientConfig

SendMessageWithVIPChannelProperty

构造器概要

构造器

构造器和说明
DefaultMQPullConsumer()
DefaultMQPullConsumer(com.alibaba.rocketmq.remoting.RPCHook rpcHook)
DefaultMQPullConsumer(String consumerGroup)
DefaultMQPullConsumer(String consumerGroup, com.alibaba.rocketmq.remoting.RPCHook rpcHook)

方法概要

方法

限定符和类型	方法和说明
void	createTopic(String key, String newTopic, int queueNum) Creates an topic
void	createTopic(String key, String newTopic, int queueNum, int topicSysFlag) Creates an topic
long	earliestMsgStoreTime(MessageQueue mq) Gets the earliest stored message time
long	fetchConsumeOffset(MessageQueue mq, boolean fromStore) Fetch the offset
Set<MessageQueue>	fetchMessageQueuesInBalance(String topic) Fetch the message queues according to the topic
Set<MessageQueue>	fetchSubscribeMessageQueues(String topic) Fetch message queues from consumer cache according to the topic
AllocateMessageQueueStrategy	getAllocateMessageQueueStrategy()
long	getBrokerSuspendMaxTimeMillis()
String	getConsumerGroup()
long	getConsumerPullTimeoutMillis()
long	getConsumerTimeoutMillisWhenSuspend()
DefaultMQPullConsumerImpl	getDefaultMQPullConsumerImpl()
int	getMaxReconsumeTimes()
MessageModel	getMessageModel()
MessageQueueListener	getMessageQueueListener()
OffsetStore	getOffsetStore()
Set<String>	getRegisterTopics()
boolean	isUnitMode()
long	maxOffset(MessageQueue mq) Gets the max offset
long	minOffset(MessageQueue mq) Gets the minimum offset
PullResult	pull(MessageQueue mq, String subExpression, long offset, int maxNums) Pulling the messages,not blocking
PullResult	pull(MessageQueue mq, String subExpression, long offset, int maxNums, long timeout) Pulling the messages in the specified timeout
void	pull(MessageQueue mq, String subExpression, long offset, int maxNums, PullCallback pullCallback) Pulling the messages in a async. way
void	pull(MessageQueue mq, String subExpression, long offset, int maxNums, PullCallback pullCallback, long timeout) Pulling the messages in a async. way
PullResult	pullBlockIfNotFound(MessageQueue mq, String subExpression, long offset, int maxNums) Pulling the messages,if no message arrival,blocking some time
void	pullBlockIfNotFound(MessageQueue mq, String subExpression, long offset, int maxNums, PullCallback pullCallback) Pulling the messages through callback function,if no message arrival,blocking.
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end) Query messages
void	registerMessageQueueListener(String topic, MessageQueueListener listener) Register the message queue listener
long	searchOffset(MessageQueue mq, long timestamp) Gets the message queue offset according to some time in milliseconds be cautious to call because of more IO overhead
void	sendMessageBack(MessageExt msg, int delayLevel) If consuming failure,message will be send back to the brokers,and delay consuming some time
void	sendMessageBack(MessageExt msg, int delayLevel, String brokerName) If consuming failure,message will be send back to the broker,and delay consuming some time
void	sendMessageBack(MessageExt msg, int delayLevel, String brokerName, String consumerGroup) If consuming failure,message will be send back to the broker,and delay consuming in some time later.
void	setAllocateMessageQueueStrategy(AllocateMessageQueueStrategy allocateMessageQueueStrategy)
void	setBrokerSuspendMaxTimeMillis(long brokerSuspendMaxTimeMillis)
void	setConsumerGroup(String consumerGroup)
void	setConsumerPullTimeoutMillis(long consumerPullTimeoutMillis)
void	setConsumerTimeoutMillisWhenSuspend(long consumerTimeoutMillisWhenSuspend)
void	setMaxReconsumeTimes(int maxReconsumeTimes)
void	setMessageModel(MessageModel messageModel)
void	setMessageQueueListener(MessageQueueListener messageQueueListener)
void	setOffsetStore(OffsetStore offsetStore)
void	setRegisterTopics(Set<String> registerTopics)
void	setUnitMode(boolean isUnitMode)
void	shutdown() Shutdown the consumer
void	start() Start the consumer
void	updateConsumeOffset(MessageQueue mq, long offset) Update the offset
MessageExt	viewMessage(String offsetMsgId) Query message according tto message id
MessageExt	viewMessage(String topic, String uniqKey) 唯一键查询

从类继承的方法 com.alibaba.rocketmq.client.ClientConfig

buildMQClientId, changeInstanceNameToPID, cloneClientConfig, getClientCallbackExecutorThreads, getClientIP, getHeartbeatBrokerInterval, getInstanceName, getNamesrvAddr, getPersistConsumerOffsetInterval, getPollNameServerInteval, getUnitName, isVipChannelEnabled, resetClientConfig, setClientCallbackExecutorThreads, setClientIP, setHeartbeatBrokerInterval, setInstanceName, setNamesrvAddr, setPersistConsumerOffsetInterval, setPollNameServerInteval, setUnitName, setVipChannelEnabled, toString

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

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

字段详细资料

defaultMQPullConsumerImpl

protected final transient DefaultMQPullConsumerImpl defaultMQPullConsumerImpl

构造器详细资料

DefaultMQPullConsumer

public DefaultMQPullConsumer()

DefaultMQPullConsumer

public DefaultMQPullConsumer(String consumerGroup,
                     com.alibaba.rocketmq.remoting.RPCHook rpcHook)

DefaultMQPullConsumer

public DefaultMQPullConsumer(String consumerGroup)

DefaultMQPullConsumer

public DefaultMQPullConsumer(com.alibaba.rocketmq.remoting.RPCHook rpcHook)

方法详细资料

createTopic

public void createTopic(String key,
               String newTopic,
               int queueNum)
                 throws MQClientException

从接口复制的说明: MQAdmin

Creates an topic

指定者:

createTopic 在接口中 MQAdmin

参数:

key - accesskey

newTopic - topic name

queueNum - topic's queue number

抛出:

MQClientException

createTopic

public void createTopic(String key,
               String newTopic,
               int queueNum,
               int topicSysFlag)
                 throws MQClientException

从接口复制的说明: MQAdmin

Creates an topic

指定者:

createTopic 在接口中 MQAdmin

参数:

key - accesskey

newTopic - topic name

queueNum - topic's queue number

topicSysFlag - topic system flag

抛出:

MQClientException

searchOffset

public long searchOffset(MessageQueue mq,
                long timestamp)
                  throws MQClientException

从接口复制的说明: MQAdmin

Gets the message queue offset according to some time in milliseconds
be cautious to call because of more IO overhead

指定者:

searchOffset 在接口中 MQAdmin

参数:

mq - Instance of MessageQueue

timestamp - from when in milliseconds.

返回:

offset

抛出:

MQClientException

maxOffset

public long maxOffset(MessageQueue mq)
               throws MQClientException

从接口复制的说明: MQAdmin

Gets the max offset

指定者:

maxOffset 在接口中 MQAdmin

参数:

mq - Instance of MessageQueue

返回:

the max offset

抛出:

MQClientException

minOffset

public long minOffset(MessageQueue mq)
               throws MQClientException

从接口复制的说明: MQAdmin

Gets the minimum offset

指定者:

minOffset 在接口中 MQAdmin

参数:

mq - Instance of MessageQueue

返回:

the minimum offset

抛出:

MQClientException

earliestMsgStoreTime

public long earliestMsgStoreTime(MessageQueue mq)
                          throws MQClientException

从接口复制的说明: MQAdmin

Gets the earliest stored message time

指定者:

earliestMsgStoreTime 在接口中 MQAdmin

参数:

mq - Instance of MessageQueue

返回:

the time in microseconds

抛出:

MQClientException

viewMessage

public MessageExt viewMessage(String offsetMsgId)
                       throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                              MQBrokerException,
                              InterruptedException,
                              MQClientException

从接口复制的说明: MQAdmin

Query message according tto message id

指定者:

viewMessage 在接口中 MQAdmin

返回:

message

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

queryMessage

public QueryResult queryMessage(String topic,
                       String key,
                       int maxNum,
                       long begin,
                       long end)
                         throws MQClientException,
                                InterruptedException

从接口复制的说明: MQAdmin

Query messages

指定者:

queryMessage 在接口中 MQAdmin

参数:

topic - message topic

key - message key index word

maxNum - max message number

begin - from when

end - to when

返回:

Instance of QueryResult

抛出:

MQClientException

InterruptedException

getAllocateMessageQueueStrategy

public AllocateMessageQueueStrategy getAllocateMessageQueueStrategy()

setAllocateMessageQueueStrategy

public void setAllocateMessageQueueStrategy(AllocateMessageQueueStrategy allocateMessageQueueStrategy)

getBrokerSuspendMaxTimeMillis

public long getBrokerSuspendMaxTimeMillis()

setBrokerSuspendMaxTimeMillis

public void setBrokerSuspendMaxTimeMillis(long brokerSuspendMaxTimeMillis)

getConsumerGroup

public String getConsumerGroup()

setConsumerGroup

public void setConsumerGroup(String consumerGroup)

getConsumerPullTimeoutMillis

public long getConsumerPullTimeoutMillis()

setConsumerPullTimeoutMillis

public void setConsumerPullTimeoutMillis(long consumerPullTimeoutMillis)

getConsumerTimeoutMillisWhenSuspend

public long getConsumerTimeoutMillisWhenSuspend()

setConsumerTimeoutMillisWhenSuspend

public void setConsumerTimeoutMillisWhenSuspend(long consumerTimeoutMillisWhenSuspend)

getMessageModel

public MessageModel getMessageModel()

setMessageModel

public void setMessageModel(MessageModel messageModel)

getMessageQueueListener

public MessageQueueListener getMessageQueueListener()

setMessageQueueListener

public void setMessageQueueListener(MessageQueueListener messageQueueListener)

getRegisterTopics

public Set<String> getRegisterTopics()

setRegisterTopics

public void setRegisterTopics(Set<String> registerTopics)

sendMessageBack

public void sendMessageBack(MessageExt msg,
                   int delayLevel)
                     throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                            MQBrokerException,
                            InterruptedException,
                            MQClientException

从接口复制的说明: MQConsumer

If consuming failure,message will be send back to the brokers,and delay consuming some time

指定者:

sendMessageBack 在接口中 MQConsumer

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

sendMessageBack

public void sendMessageBack(MessageExt msg,
                   int delayLevel,
                   String brokerName)
                     throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                            MQBrokerException,
                            InterruptedException,
                            MQClientException

从接口复制的说明: MQConsumer

If consuming failure,message will be send back to the broker,and delay consuming some time

指定者:

sendMessageBack 在接口中 MQConsumer

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

fetchSubscribeMessageQueues

public Set<MessageQueue> fetchSubscribeMessageQueues(String topic)
                                              throws MQClientException

从接口复制的说明: MQConsumer

Fetch message queues from consumer cache according to the topic

指定者:

fetchSubscribeMessageQueues 在接口中 MQConsumer

参数:

topic - message topic

返回:

queue set

抛出:

MQClientException

start

public void start()
           throws MQClientException

从接口复制的说明: MQPullConsumer

Start the consumer

指定者:

start 在接口中 MQPullConsumer

抛出:

MQClientException

shutdown

public void shutdown()

从接口复制的说明: MQPullConsumer

Shutdown the consumer

指定者:

shutdown 在接口中 MQPullConsumer

registerMessageQueueListener

public void registerMessageQueueListener(String topic,
                                MessageQueueListener listener)

从接口复制的说明: MQPullConsumer

Register the message queue listener

指定者:

registerMessageQueueListener 在接口中 MQPullConsumer

pull

public PullResult pull(MessageQueue mq,
              String subExpression,
              long offset,
              int maxNums)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       MQBrokerException,
                       InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages,not blocking

指定者:

pull 在接口中 MQPullConsumer

参数:

mq - from which message queue

subExpression - subscription expression.it only support or operation such as "tag1 || tag2 || tag3"
if null or * expression,meaning subscribe all

offset - from where to pull

maxNums - max pulling numbers

返回:

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

pull

public PullResult pull(MessageQueue mq,
              String subExpression,
              long offset,
              int maxNums,
              long timeout)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       MQBrokerException,
                       InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages in the specified timeout

指定者:

pull 在接口中 MQPullConsumer

返回:

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

pull

public void pull(MessageQueue mq,
        String subExpression,
        long offset,
        int maxNums,
        PullCallback pullCallback)
          throws MQClientException,
                 com.alibaba.rocketmq.remoting.exception.RemotingException,
                 InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages in a async. way

指定者:

pull 在接口中 MQPullConsumer

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

pull

public void pull(MessageQueue mq,
        String subExpression,
        long offset,
        int maxNums,
        PullCallback pullCallback,
        long timeout)
          throws MQClientException,
                 com.alibaba.rocketmq.remoting.exception.RemotingException,
                 InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages in a async. way

指定者:

pull 在接口中 MQPullConsumer

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

pullBlockIfNotFound

public PullResult pullBlockIfNotFound(MessageQueue mq,
                             String subExpression,
                             long offset,
                             int maxNums)
                               throws MQClientException,
                                      com.alibaba.rocketmq.remoting.exception.RemotingException,
                                      MQBrokerException,
                                      InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages,if no message arrival,blocking some time

指定者:

pullBlockIfNotFound 在接口中 MQPullConsumer

返回:

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

pullBlockIfNotFound

public void pullBlockIfNotFound(MessageQueue mq,
                       String subExpression,
                       long offset,
                       int maxNums,
                       PullCallback pullCallback)
                         throws MQClientException,
                                com.alibaba.rocketmq.remoting.exception.RemotingException,
                                InterruptedException

从接口复制的说明: MQPullConsumer

Pulling the messages through callback function,if no message arrival,blocking.

指定者:

pullBlockIfNotFound 在接口中 MQPullConsumer

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

updateConsumeOffset

public void updateConsumeOffset(MessageQueue mq,
                       long offset)
                         throws MQClientException

从接口复制的说明: MQPullConsumer

Update the offset

指定者:

updateConsumeOffset 在接口中 MQPullConsumer

抛出:

MQClientException

fetchConsumeOffset

public long fetchConsumeOffset(MessageQueue mq,
                      boolean fromStore)
                        throws MQClientException

从接口复制的说明: MQPullConsumer

Fetch the offset

指定者:

fetchConsumeOffset 在接口中 MQPullConsumer

返回:

抛出:

MQClientException

fetchMessageQueuesInBalance

public Set<MessageQueue> fetchMessageQueuesInBalance(String topic)
                                              throws MQClientException

从接口复制的说明: MQPullConsumer

Fetch the message queues according to the topic

指定者:

fetchMessageQueuesInBalance 在接口中 MQPullConsumer

参数:

topic - message topic

返回:

message queue set

抛出:

MQClientException

viewMessage

public MessageExt viewMessage(String topic,
                     String uniqKey)
                       throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                              MQBrokerException,
                              InterruptedException,
                              MQClientException

从接口复制的说明: MQAdmin

唯一键查询

指定者:

viewMessage 在接口中 MQAdmin

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

sendMessageBack

public void sendMessageBack(MessageExt msg,
                   int delayLevel,
                   String brokerName,
                   String consumerGroup)
                     throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                            MQBrokerException,
                            InterruptedException,
                            MQClientException

从接口复制的说明: MQPullConsumer

If consuming failure,message will be send back to the broker,and delay consuming in some time later.
Mind! message can only be consumed in the same group.

指定者:

sendMessageBack 在接口中 MQPullConsumer

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

getOffsetStore

public OffsetStore getOffsetStore()

setOffsetStore

public void setOffsetStore(OffsetStore offsetStore)

getDefaultMQPullConsumerImpl

public DefaultMQPullConsumerImpl getDefaultMQPullConsumerImpl()

isUnitMode

public boolean isUnitMode()

覆盖:

isUnitMode 在类中 ClientConfig

setUnitMode

public void setUnitMode(boolean isUnitMode)

覆盖:

setUnitMode 在类中 ClientConfig

getMaxReconsumeTimes

public int getMaxReconsumeTimes()

setMaxReconsumeTimes

public void setMaxReconsumeTimes(int maxReconsumeTimes)