com.aliyun.mns.client

类 CloudQueue

java.lang.Object

com.aliyun.mns.client.CloudQueue

public final class CloudQueue
extends Object

构造器概要

构造器

限定符	构造器和说明
protected	CloudQueue(String queueURL, ServiceClient client, ServiceCredentials credentials, URI endpoint)

方法概要

方法

限定符和类型	方法和说明
AsyncResult<Void>	asyncBatchDeleteMessage(List<String> receiptHandles, AsyncCallback<Void> callback)
AsyncResult<List<Message>>	asyncBatchPeekMessage(int batchSize, AsyncCallback<List<Message>> callback) 异步批量查看消息
AsyncResult<List<Message>>	asyncBatchPopMessage(int batchSize, AsyncCallback<List<Message>> callback) 异步批量获取队列中的消息
AsyncResult<List<Message>>	asyncBatchPopMessage(int batchSize, int waitSeconds, AsyncCallback<List<Message>> callback) 异步批量获取队列中的消息
AsyncResult<List<Message>>	asyncBatchPutMessage(List<Message> messages, AsyncCallback<List<Message>> callback) 异步批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
AsyncResult<Message>	asyncChangeMessageVisibility(String receiptHandle, int visibilityTimeout, AsyncCallback<Message> callback) 异步改变消息的不可见时间
AsyncResult<String>	asyncChangeMessageVisibilityTimeout(String receiptHandle, int visibilityTimeout, AsyncCallback<String> callback) 异步改变消息的不可见时间
AsyncResult<Void>	asyncDeleteMessage(String receiptHandle, AsyncCallback<Void> callback) 异步删除消息
AsyncResult<Message>	asyncPeekMessage(AsyncCallback<Message> callback) 异步查看队列消息
AsyncResult<Message>	asyncPopMessage(AsyncCallback<Message> callback) 异步获取队列中的消息
AsyncResult<Message>	asyncPopMessage(int waitSeconds, AsyncCallback<Message> callback) 异步获取队列中的消息
AsyncResult<Message>	asyncPutMessage(Message message, AsyncCallback<Message> callback) 异步发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
void	batchDeleteMessage(List<String> receiptHandles) 批量删除消息
List<Message>	batchPeekMessage(int batchSize) 批量查看队列消息
List<Message>	batchPopMessage(int batchSize) 批量获取队列中的消息
List<Message>	batchPopMessage(int batchSize, int waitSeconds) 批量获取队列中的消息
List<Message>	batchPutMessage(List<Message> messages) 批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
Message	changeMessageVisibility(String receiptHandle, int visibilityTimeout) 改变消息的不可见时间
String	changeMessageVisibilityTimeout(String receiptHandle, int visibilityTimeout) 改变消息的不可见时间
String	create() 创建队列，使用默认属性
String	create(QueueMeta queueMeta) 创建队列，队列属性由参数queueMeta设置
void	delete() 删除队列
void	deleteMessage(String receiptHandle) 删除消息
QueueMeta	getAttributes() 获取队列的属性
String	getQueueURL()
boolean	isMessageNotExist(ServiceException e)
boolean	isQueueExist() Check if queue is exist already.
Message	peekMessage() 查看队列消息
Message	popMessage() 获取队列中的消息
Message	popMessage(int waitSeconds) 获取队列中的消息
Message	putMessage(Message message) 发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
void	setAttributes(QueueMeta queueMeta) 设置队列属性

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

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

构造器详细资料

CloudQueue

protected CloudQueue(String queueURL,
          ServiceClient client,
          ServiceCredentials credentials,
          URI endpoint)

方法详细资料

create

public String create()
              throws ServiceException,
                     ClientException

创建队列，使用默认属性

返回:

队列的URL

抛出:

ServiceException

ClientException

create

public String create(QueueMeta queueMeta)
              throws ServiceException,
                     ClientException

创建队列，队列属性由参数queueMeta设置

参数:

queueMeta, - queue meta data

返回:

队列的URL

抛出:

ServiceException

ClientException

delete

public void delete()
            throws ServiceException,
                   ClientException

删除队列

抛出:

ServiceException

ClientException

getAttributes

public QueueMeta getAttributes()
                        throws ServiceException,
                               ClientException

获取队列的属性

返回:

队列属性

抛出:

ServiceException

ClientException

setAttributes

public void setAttributes(QueueMeta queueMeta)
                   throws ClientException,
                          ServiceException

设置队列属性

参数:

queueMeta, - queue meta data

抛出:

ClientException

ServiceException

peekMessage

public Message peekMessage()
                    throws ServiceException,
                           ClientException

查看队列消息

返回:

查找到的消息

抛出:

ServiceException

ClientException - 消息不存在时返回null

asyncPeekMessage

public AsyncResult<Message> asyncPeekMessage(AsyncCallback<Message> callback)
                                      throws ClientException

异步查看队列消息

参数:

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

batchPeekMessage

public List<Message> batchPeekMessage(int batchSize)
                               throws ServiceException,
                                      ClientException

批量查看队列消息

参数:

batchSize - 本次最多查看消息的条数

返回:

查找到的消息

抛出:

ServiceException

ClientException - 消息不存在时返回null

asyncBatchPeekMessage

public AsyncResult<List<Message>> asyncBatchPeekMessage(int batchSize,
                                               AsyncCallback<List<Message>> callback)
                                                 throws ClientException

异步批量查看消息

参数:

batchSize - 本次最多查看消息的条数

callback -

返回:

异步结果调用句柄

抛出:

ClientException

changeMessageVisibilityTimeout

public String changeMessageVisibilityTimeout(String receiptHandle,
                                    int visibilityTimeout)
                                      throws ServiceException,
                                             ClientException

改变消息的不可见时间

参数:

receiptHandle - 消息句柄

visibilityTimeout - 消息不可见时间，单位是秒

返回:

新的消息句柄

抛出:

ServiceException

ClientException

asyncChangeMessageVisibilityTimeout

public AsyncResult<String> asyncChangeMessageVisibilityTimeout(String receiptHandle,
                                                      int visibilityTimeout,
                                                      AsyncCallback<String> callback)
                                                        throws ClientException

异步改变消息的不可见时间

参数:

receiptHandle - 待改变消息的句柄

visibilityTimeout - 新的消息不可见时间，单位是秒

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

changeMessageVisibility

public Message changeMessageVisibility(String receiptHandle,
                              int visibilityTimeout)
                                throws ServiceException,
                                       ClientException

改变消息的不可见时间

参数:

receiptHandle - 消息句柄

visibilityTimeout - 消息不可见时间，单位是秒

返回:

新的消息，保含消息句柄和下次可见时间

抛出:

ServiceException

ClientException

asyncChangeMessageVisibility

public AsyncResult<Message> asyncChangeMessageVisibility(String receiptHandle,
                                                int visibilityTimeout,
                                                AsyncCallback<Message> callback)
                                                  throws ClientException

异步改变消息的不可见时间

参数:

receiptHandle - 待改变消息的句柄

visibilityTimeout - 新的消息不可见时间，单位是秒

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

popMessage

public Message popMessage()
                   throws ServiceException,
                          ClientException

获取队列中的消息

返回:

返回队列中的一个消息

抛出:

ServiceException

ClientException - 在队列中没有消息的时候返回null

popMessage

public Message popMessage(int waitSeconds)
                   throws ServiceException,
                          ClientException

获取队列中的消息

参数:

waitSeconds - 长轮询等待时间，单位是秒

返回:

队列中的一个消息

抛出:

ServiceException

ClientException - 队列中没有消息的时候返回null

asyncPopMessage

public AsyncResult<Message> asyncPopMessage(AsyncCallback<Message> callback)
                                     throws ClientException

异步获取队列中的消息

参数:

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

asyncPopMessage

public AsyncResult<Message> asyncPopMessage(int waitSeconds,
                                   AsyncCallback<Message> callback)
                                     throws ClientException

异步获取队列中的消息

参数:

waitSeconds - 长轮询等待时间，单位是秒

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

batchPopMessage

public List<Message> batchPopMessage(int batchSize)
                              throws ServiceException,
                                     ClientException

批量获取队列中的消息

参数:

batchSize - 本次最多获取消息的条数

返回:

消息列表

抛出:

ServiceException

ClientException - 队列中没有消息的时候返回null

batchPopMessage

public List<Message> batchPopMessage(int batchSize,
                            int waitSeconds)
                              throws ServiceException,
                                     ClientException

批量获取队列中的消息

参数:

batchSize - 本次最多获取消息的条数

waitSeconds - 长轮询等待时间，单位是秒

返回:

消息列表

抛出:

ServiceException

ClientException - 队列中没有消息的时候返回null

asyncBatchPopMessage

public AsyncResult<List<Message>> asyncBatchPopMessage(int batchSize,
                                              AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量获取队列中的消息

参数:

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

asyncBatchPopMessage

public AsyncResult<List<Message>> asyncBatchPopMessage(int batchSize,
                                              int waitSeconds,
                                              AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量获取队列中的消息

参数:

waitSeconds - 长轮询等待时间，单位是秒

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

deleteMessage

public void deleteMessage(String receiptHandle)
                   throws ServiceException,
                          ClientException

删除消息

参数:

receiptHandle - 消息句柄

抛出:

ServiceException

ClientException

asyncDeleteMessage

public AsyncResult<Void> asyncDeleteMessage(String receiptHandle,
                                   AsyncCallback<Void> callback)
                                     throws ClientException

异步删除消息

参数:

receiptHandle - 消息句柄

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

batchDeleteMessage

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

批量删除消息

参数:

receiptHandles - 消息句柄列表

抛出:

ServiceException

ClientException

asyncBatchDeleteMessage

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

参数:

receiptHandles - 消息句柄列表

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

putMessage

public Message putMessage(Message message)
                   throws ServiceException,
                          ClientException

发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

参数:

message - 待发送的消息

返回:

发送成功的消息

抛出:

ServiceException

ClientException

asyncPutMessage

public AsyncResult<Message> asyncPutMessage(Message message,
                                   AsyncCallback<Message> callback)
                                     throws ClientException

异步发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

参数:

message - 待发送的消息

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

batchPutMessage

public List<Message> batchPutMessage(List<Message> messages)
                              throws ServiceException,
                                     ClientException

批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

参数:

messages - 待发送的消息

返回:

发送成功的消息

抛出:

ServiceException

ClientException

asyncBatchPutMessage

public AsyncResult<List<Message>> asyncBatchPutMessage(List<Message> messages,
                                              AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

参数:

messages - 待发送的消息

callback - 异步回调对象

返回:

异步结果调用句柄

抛出:

ClientException

getQueueURL

public String getQueueURL()

isMessageNotExist

public boolean isMessageNotExist(ServiceException e)

isQueueExist

public boolean isQueueExist()
                     throws ServiceException,
                            ClientException

Check if queue is exist already.

返回:

true means queue exists, false means queue does not exist.

抛出:

ServiceException - ClientException

ClientException