com.alibaba.rocketmq.client.consumer

类 DefaultMQPushConsumer

java.lang.Object

com.alibaba.rocketmq.client.ClientConfig

com.alibaba.rocketmq.client.consumer.DefaultMQPushConsumer

所有已实现的接口:

MQConsumer, MQPushConsumer, MQAdmin

public class DefaultMQPushConsumer
extends ClientConfig
implements MQPushConsumer

Wrapped push consumer.in fact,it works as remarkable as the pull consumer

作者:

shijia.wxr

字段概要

字段

限定符和类型	字段和说明
protected DefaultMQPushConsumerImpl	defaultMQPushConsumerImpl

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

SendMessageWithVIPChannelProperty

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
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
Set<MessageQueue>	fetchSubscribeMessageQueues(String topic) Fetch message queues from consumer cache according to the topic
long	getAdjustThreadPoolNumsThreshold()
AllocateMessageQueueStrategy	getAllocateMessageQueueStrategy()
int	getConsumeConcurrentlyMaxSpan()
ConsumeFromWhere	getConsumeFromWhere()
int	getConsumeMessageBatchMaxSize()
String	getConsumerGroup()
int	getConsumeThreadMax()
int	getConsumeThreadMin()
long	getConsumeTimeout()
String	getConsumeTimestamp()
DefaultMQPushConsumerImpl	getDefaultMQPushConsumerImpl()
int	getMaxReconsumeTimes()
MessageListener	getMessageListener()
MessageModel	getMessageModel()
OffsetStore	getOffsetStore()
int	getPullBatchSize()
long	getPullInterval()
int	getPullThresholdForQueue()
Map<String,String>	getSubscription()
long	getSuspendCurrentQueueTimeMillis()
boolean	isPostSubscriptionWhenPull()
boolean	isUnitMode()
long	maxOffset(MessageQueue mq) Gets the max offset
long	minOffset(MessageQueue mq) Gets the minimum offset
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end) Query messages
void	registerMessageListener(MessageListener messageListener) 已过时。
void	registerMessageListener(MessageListenerConcurrently messageListener)
void	registerMessageListener(MessageListenerOrderly messageListener)
void	resume() Resume the consumption
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	setAdjustThreadPoolNumsThreshold(long adjustThreadPoolNumsThreshold)
void	setAllocateMessageQueueStrategy(AllocateMessageQueueStrategy allocateMessageQueueStrategy)
void	setConsumeConcurrentlyMaxSpan(int consumeConcurrentlyMaxSpan)
void	setConsumeFromWhere(ConsumeFromWhere consumeFromWhere)
void	setConsumeMessageBatchMaxSize(int consumeMessageBatchMaxSize)
void	setConsumerGroup(String consumerGroup)
void	setConsumeThreadMax(int consumeThreadMax)
void	setConsumeThreadMin(int consumeThreadMin)
void	setConsumeTimeout(long consumeTimeout)
void	setConsumeTimestamp(String consumeTimestamp)
void	setMaxReconsumeTimes(int maxReconsumeTimes)
void	setMessageListener(MessageListener messageListener)
void	setMessageModel(MessageModel messageModel)
void	setOffsetStore(OffsetStore offsetStore)
void	setPostSubscriptionWhenPull(boolean postSubscriptionWhenPull)
void	setPullBatchSize(int pullBatchSize)
void	setPullInterval(long pullInterval)
void	setPullThresholdForQueue(int pullThresholdForQueue)
void	setSubscription(Map<String,String> subscription)
void	setSuspendCurrentQueueTimeMillis(long suspendCurrentQueueTimeMillis)
void	setUnitMode(boolean isUnitMode)
void	shutdown() Shutdown the consumer
void	start() Start the consumer
void	subscribe(String topic, String subExpression) Subscribe some topic
void	subscribe(String topic, String fullClassName, String filterClassSource) Subscribe some topic
void	suspend() Suspend the consumption
void	unsubscribe(String topic) Unsubscribe consumption some topic
void	updateCorePoolSize(int corePoolSize) Update the consumer thread pool size Dynamically
MessageExt	viewMessage(String offsetMsgId) Query message according tto message id
MessageExt	viewMessage(String topic, String msgId)

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

字段详细资料

defaultMQPushConsumerImpl

protected final transient DefaultMQPushConsumerImpl defaultMQPushConsumerImpl

构造器详细资料

DefaultMQPushConsumer

public DefaultMQPushConsumer()

DefaultMQPushConsumer

public DefaultMQPushConsumer(String consumerGroup,
                     com.alibaba.rocketmq.remoting.RPCHook rpcHook,
                     AllocateMessageQueueStrategy allocateMessageQueueStrategy)

DefaultMQPushConsumer

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

DefaultMQPushConsumer

public DefaultMQPushConsumer(String consumerGroup)

方法详细资料

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

参数:

offsetMsgId - message id

返回:

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

viewMessage

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

指定者:

viewMessage 在接口中 MQAdmin

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

getAllocateMessageQueueStrategy

public AllocateMessageQueueStrategy getAllocateMessageQueueStrategy()

setAllocateMessageQueueStrategy

public void setAllocateMessageQueueStrategy(AllocateMessageQueueStrategy allocateMessageQueueStrategy)

getConsumeConcurrentlyMaxSpan

public int getConsumeConcurrentlyMaxSpan()

setConsumeConcurrentlyMaxSpan

public void setConsumeConcurrentlyMaxSpan(int consumeConcurrentlyMaxSpan)

getConsumeFromWhere

public ConsumeFromWhere getConsumeFromWhere()

setConsumeFromWhere

public void setConsumeFromWhere(ConsumeFromWhere consumeFromWhere)

getConsumeMessageBatchMaxSize

public int getConsumeMessageBatchMaxSize()

setConsumeMessageBatchMaxSize

public void setConsumeMessageBatchMaxSize(int consumeMessageBatchMaxSize)

getConsumerGroup

public String getConsumerGroup()

setConsumerGroup

public void setConsumerGroup(String consumerGroup)

getConsumeThreadMax

public int getConsumeThreadMax()

setConsumeThreadMax

public void setConsumeThreadMax(int consumeThreadMax)

getConsumeThreadMin

public int getConsumeThreadMin()

setConsumeThreadMin

public void setConsumeThreadMin(int consumeThreadMin)

getDefaultMQPushConsumerImpl

public DefaultMQPushConsumerImpl getDefaultMQPushConsumerImpl()

getMessageListener

public MessageListener getMessageListener()

setMessageListener

public void setMessageListener(MessageListener messageListener)

getMessageModel

public MessageModel getMessageModel()

setMessageModel

public void setMessageModel(MessageModel messageModel)

getPullBatchSize

public int getPullBatchSize()

setPullBatchSize

public void setPullBatchSize(int pullBatchSize)

getPullInterval

public long getPullInterval()

setPullInterval

public void setPullInterval(long pullInterval)

getPullThresholdForQueue

public int getPullThresholdForQueue()

setPullThresholdForQueue

public void setPullThresholdForQueue(int pullThresholdForQueue)

getSubscription

public Map<String,String> getSubscription()

setSubscription

public void setSubscription(Map<String,String> subscription)

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

从接口复制的说明: MQPushConsumer

Start the consumer

指定者:

start 在接口中 MQPushConsumer

抛出:

MQClientException

shutdown

public void shutdown()

从接口复制的说明: MQPushConsumer

Shutdown the consumer

指定者:

shutdown 在接口中 MQPushConsumer

registerMessageListener

@Deprecated
public void registerMessageListener(MessageListener messageListener)

已过时。

从接口复制的说明: MQPushConsumer

Register the message listener

指定者:

registerMessageListener 在接口中 MQPushConsumer

registerMessageListener

public void registerMessageListener(MessageListenerConcurrently messageListener)

指定者:

registerMessageListener 在接口中 MQPushConsumer

registerMessageListener

public void registerMessageListener(MessageListenerOrderly messageListener)

指定者:

registerMessageListener 在接口中 MQPushConsumer

subscribe

public void subscribe(String topic,
             String subExpression)
               throws MQClientException

从接口复制的说明: MQPushConsumer

Subscribe some topic

指定者:

subscribe 在接口中 MQPushConsumer

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

抛出:

MQClientException

subscribe

public void subscribe(String topic,
             String fullClassName,
             String filterClassSource)
               throws MQClientException

从接口复制的说明: MQPushConsumer

Subscribe some topic

指定者:

subscribe 在接口中 MQPushConsumer

fullClassName - full class name，must extend com.alibaba.rocketmq.common.filter. MessageFilter

filterClassSource - class source code，used UTF-8 file encoding,must be responsible for your code safety

抛出:

MQClientException

unsubscribe

public void unsubscribe(String topic)

从接口复制的说明: MQPushConsumer

Unsubscribe consumption some topic

指定者:

unsubscribe 在接口中 MQPushConsumer

参数:

topic - message topic

updateCorePoolSize

public void updateCorePoolSize(int corePoolSize)

从接口复制的说明: MQPushConsumer

Update the consumer thread pool size Dynamically

指定者:

updateCorePoolSize 在接口中 MQPushConsumer

suspend

public void suspend()

从接口复制的说明: MQPushConsumer

Suspend the consumption

指定者:

suspend 在接口中 MQPushConsumer

resume

public void resume()

从接口复制的说明: MQPushConsumer

Resume the consumption

指定者:

resume 在接口中 MQPushConsumer

getOffsetStore

public OffsetStore getOffsetStore()

setOffsetStore

public void setOffsetStore(OffsetStore offsetStore)

getConsumeTimestamp

public String getConsumeTimestamp()

setConsumeTimestamp

public void setConsumeTimestamp(String consumeTimestamp)

isPostSubscriptionWhenPull

public boolean isPostSubscriptionWhenPull()

setPostSubscriptionWhenPull

public void setPostSubscriptionWhenPull(boolean postSubscriptionWhenPull)

isUnitMode

public boolean isUnitMode()

覆盖:

isUnitMode 在类中 ClientConfig

setUnitMode

public void setUnitMode(boolean isUnitMode)

覆盖:

setUnitMode 在类中 ClientConfig

getAdjustThreadPoolNumsThreshold

public long getAdjustThreadPoolNumsThreshold()

setAdjustThreadPoolNumsThreshold

public void setAdjustThreadPoolNumsThreshold(long adjustThreadPoolNumsThreshold)

getMaxReconsumeTimes

public int getMaxReconsumeTimes()

setMaxReconsumeTimes

public void setMaxReconsumeTimes(int maxReconsumeTimes)

getSuspendCurrentQueueTimeMillis

public long getSuspendCurrentQueueTimeMillis()

setSuspendCurrentQueueTimeMillis

public void setSuspendCurrentQueueTimeMillis(long suspendCurrentQueueTimeMillis)

getConsumeTimeout

public long getConsumeTimeout()

setConsumeTimeout

public void setConsumeTimeout(long consumeTimeout)