com.alibaba.rocketmq.client.consumer

接口 MQPullConsumer

所有超级接口:

MQAdmin, MQConsumer

所有已知实现类:

DefaultMQPullConsumer

public interface MQPullConsumer
extends MQConsumer

Pulling consumer interface

从以下版本开始:

2013-7-24

作者:

shijia.wxr

方法概要

方法

限定符和类型	方法和说明
long	fetchConsumeOffset(MessageQueue mq, boolean fromStore) Fetch the offset
Set<MessageQueue>	fetchMessageQueuesInBalance(String topic) Fetch the message queues according to the topic
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.
void	registerMessageQueueListener(String topic, MessageQueueListener listener) Register the message queue listener
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	shutdown() Shutdown the consumer
void	start() Start the consumer
void	updateConsumeOffset(MessageQueue mq, long offset) Update the offset

从接口继承的方法 com.alibaba.rocketmq.client.consumer.MQConsumer

fetchSubscribeMessageQueues, sendMessageBack, sendMessageBack

从接口继承的方法 com.alibaba.rocketmq.client.MQAdmin

createTopic, createTopic, earliestMsgStoreTime, maxOffset, minOffset, queryMessage, searchOffset, viewMessage, viewMessage

方法详细资料

start

void start()
           throws MQClientException

Start the consumer

抛出:

MQClientException

shutdown

void shutdown()

Shutdown the consumer

registerMessageQueueListener

void registerMessageQueueListener(String topic,
                                MessageQueueListener listener)

Register the message queue listener

参数:

topic -

listener -

pull

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

Pulling the messages,not blocking

参数:

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

InterruptedException

MQBrokerException

com.alibaba.rocketmq.remoting.exception.RemotingException

pull

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

Pulling the messages in the specified timeout

参数:

mq -

subExpression -

offset -

maxNums -

timeout -

返回:

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

pull

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

Pulling the messages in a async. way

参数:

mq -

subExpression -

offset -

maxNums -

pullCallback -

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

pull

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

Pulling the messages in a async. way

参数:

mq -

subExpression -

offset -

maxNums -

pullCallback -

timeout -

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

pullBlockIfNotFound

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

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

参数:

mq -

subExpression -

offset -

maxNums -

返回:

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

pullBlockIfNotFound

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

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

参数:

mq -

subExpression -

offset -

maxNums -

pullCallback -

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

updateConsumeOffset

void updateConsumeOffset(MessageQueue mq,
                       long offset)
                         throws MQClientException

Update the offset

参数:

mq -

offset -

抛出:

MQClientException

fetchConsumeOffset

long fetchConsumeOffset(MessageQueue mq,
                      boolean fromStore)
                        throws MQClientException

Fetch the offset

参数:

mq -

fromStore -

返回:

抛出:

MQClientException

fetchMessageQueuesInBalance

Set<MessageQueue> fetchMessageQueuesInBalance(String topic)
                                              throws MQClientException

Fetch the message queues according to the topic

参数:

topic - message topic

返回:

message queue set

抛出:

MQClientException

sendMessageBack

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

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.

参数:

msg -

delayLevel -

brokerName -

consumerGroup -

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException