com.aliyun.mq.http

类 MQConsumer

java.lang.Object

com.aliyun.mq.http.MQConsumer

public class MQConsumer
extends Object

构造器概要

构造器

限定符	构造器和说明
protected	MQConsumer(String instanceId, String topicName, String consumer, String messageTag, com.aliyun.mq.http.common.http.ServiceClient client, com.aliyun.mq.http.common.auth.ServiceCredentials credentials, URI endpoint)

方法概要

限定符和类型	方法和说明
void	ackMessage(List<String> receiptHandles) Tell server the messages are consumed success.
AsyncResult<Void>	asyncAckMessage(List<String> receiptHandles, AsyncCallback<Void> callback) Async tell server the messages are consumed success.
AsyncResult<List<Message>>	asyncConsumeMessage(int num, int pollingSecond, AsyncCallback<List<Message>> callback) async consume message from topic.
List<Message>	consumeMessage(int num, int pollingSecond) sync consume message from topic.
List<Message>	consumeMessageOrderly(int num, int pollingSecond) sync consume message from topic orderly.
String	getConsumer() the consumer group name of mq
String	getInstanceId() instance id
String	getMessageTag() filter message tag, could be null.
String	getTopicName() the topic name
String	toString()

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

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

构造器详细资料

MQConsumer

protected MQConsumer(String instanceId,
                     String topicName,
                     String consumer,
                     String messageTag,
                     com.aliyun.mq.http.common.http.ServiceClient client,
                     com.aliyun.mq.http.common.auth.ServiceCredentials credentials,
                     URI endpoint)

参数:

instanceId, - instance id

topicName, - topic name

consumer - mq cid

messageTag - message tag for filter

client, - ServiceClient object

credentials, - ServiceCredentials object

endpoint, - user mq http endpoint, ie: http://uid.mqrest.region.aliyuncs.com/

方法详细资料

getTopicName

public String getTopicName()

the topic name

返回:

topic name

getConsumer

public String getConsumer()

the consumer group name of mq

返回:

consumer(client id)

getMessageTag

public String getMessageTag()

filter message tag, could be null.

返回:

message tag(for filter)

getInstanceId

public String getInstanceId()

instance id

返回:

instance id

consumeMessage

public List<Message> consumeMessage(int num,
                                    int pollingSecond)
                             throws ServiceException,
                                    ClientException

sync consume message from topic. If the messages gotten by consumeMessage(int, int) are not acked by ackMessage(List), they will be consumable again after 300 seconds;

参数:

num - the count of messages consumed once value: 1~16

pollingSecond - if greater than 0, means the time(second) the request holden at server if there is no message to consume. If less or equal 0, means the server will response back if there is no message to consume. value: 1~30

返回:

null or List

抛出:

ServiceException

ClientException

consumeMessageOrderly

public List<Message> consumeMessageOrderly(int num,
                                           int pollingSecond)
                                    throws ServiceException,
                                           ClientException

sync consume message from topic orderly. Next messages will be consumed if all of same shard are acked. Otherwise, same messages will be consumed again after NextConsumeTime. Attention: the topic should be order topic created at console, if not, mq could not keep the order feature. This interface is suitable for globally order and partitionally order messages, and could be used in multi-thread scenes.

参数:

num - the count of messages consumed once value: 1~16

pollingSecond - if greater than 0, means the time(second) the request holden at server if there is no message to consume. If less or equal 0, means the server will response back if there is no message to consume. value: 1~30

返回:

null or List may contains several shard's messages, the messages of one shard are ordered. Get the sharding key through Message.getShardingKey()

抛出:

ServiceException

ClientException

asyncConsumeMessage

public AsyncResult<List<Message>> asyncConsumeMessage(int num,
                                                      int pollingSecond,
                                                      AsyncCallback<List<Message>> callback)

async consume message from topic. If the messages gotten by consumeMessage(int, int) are not acked by ackMessage(List), they will be consumable again after 300 seconds;

参数:

num - the count of messages consumed once value: 1~16

pollingSecond - if greater than 0, means the time(second) the request holden at server if there is no message to consume. If less or equal 0, means the server will response back if there is no message to consume. value: 1~30

callback, - user callback object

返回:

AsyncResult, you can get the result blocked.

ackMessage

public void ackMessage(List<String> receiptHandles)
                throws ServiceException,
                       ClientException

Tell server the messages are consumed success. If the messages gotten by consumeMessage(int, int) are not acked by ackMessage(List), they will be consumable again after 300 seconds;

参数:

receiptHandles - size should be 1~16, @see Message.receiptHandle

抛出:

ServiceException - Exception from server

ClientException - Exception from client

asyncAckMessage

public AsyncResult<Void> asyncAckMessage(List<String> receiptHandles,
                                         AsyncCallback<Void> callback)
                                  throws ServiceException,
                                         ClientException

Async tell server the messages are consumed success. If the messages gotten by consumeMessage(int, int) are not acked by ackMessage(List), they will be consumable again after 300 seconds;

参数:

receiptHandles - size should be 1~16, @see Message.receiptHandle,

callback, - user callback object

返回:

AsyncResult, you can get the result blocked.

抛出:

ServiceException - Exception from server

ClientException - Exception from client

toString

public String toString()

覆盖:

toString 在类中 Object