类的使用
com.alibaba.tmq.common.domain.Message

使用Message的程序包

程序包	说明
com.alibaba.tmq.client.service
com.alibaba.tmq.client.system.consumer.executer
com.alibaba.tmq.client.system.consumer.listener
com.alibaba.tmq.client.system.producer
com.alibaba.tmq.client.system.producer.checker
com.alibaba.tmq.client.system.producer.executer
com.alibaba.tmq.client.system.producer.implement
com.alibaba.tmq.common.domain
com.alibaba.tmq.common.domain.result
com.alibaba.tmq.common.service
com.alibaba.tmq.common.util

com.alibaba.tmq.client.service中Message的使用

参数类型为Message的com.alibaba.tmq.client.service中的方法

限定符和类型	方法和说明
Result<TransactionStatus>	DefaultClientService.check(ProducerKey producerKey, Message message) 事务消息检查 producerKey message
Result<Action>	DefaultClientService.push(ConsumerKey consumerKey, Message message) 推送消息
Result<Action>	DefaultClientService.push(String consumerId, Message message) 推送消息 consumerId message

com.alibaba.tmq.client.system.consumer.executer中Message的使用

参数类型为Message的com.alibaba.tmq.client.system.consumer.executer中的方法

限定符和类型	方法和说明
Result<Action>	ConsumerExecuter.consume(ConsumerKey consumerKey, Message message, ConnectionChannel connectionChannel) 消费消息 consumerKey message connectionChannel

com.alibaba.tmq.client.system.consumer.listener中Message的使用

参数类型为Message的com.alibaba.tmq.client.system.consumer.listener中的方法

限定符和类型	方法和说明
Action	MessageListener.consume(Message message, ConsumeContext context) 消费消息 message context

com.alibaba.tmq.client.system.producer中Message的使用

返回变量类型为Message的类型的com.alibaba.tmq.client.system.producer中的方法

限定符和类型	方法和说明
List<Message>	Producer.get(Message message) 获取消息 message

参数类型为Message的com.alibaba.tmq.client.system.producer中的方法

限定符和类型	方法和说明
DeleteResult	Producer.delete(Message message) 删除消息 message TMQException
List<Message>	Producer.get(Message message) 获取消息 message
SendResult	NormalProducer.send(Message message) 发送非事物消息 message TMQException
SendResult	TransactionProducer.send(Message message, LocalTransactionExecuter localTransactionExecuter, Object object) 发送事物消息 message localTransactionExecuter object TMQException
SubmitResult	NormalProducer.submit(Message message) 提交消息 message TMQException
UpdateResult	Producer.update(Message message) 更新消息 message TMQException

类型变量类型为Message的com.alibaba.tmq.client.system.producer中的方法参数

限定符和类型	方法和说明
SendResult	NormalProducer.send(List<Message> messageList) 批量发送非事物消息 messageList TMQException
SendResult	TransactionProducer.send(List<Message> messageList, LocalTransactionExecuter localTransactionExecuter, Object object) 批量发送事物消息 messageList localTransactionExecuter object TMQException
SubmitResult	NormalProducer.submit(List<? extends Message> messageList) 批量提交消息 messageList TMQException
UpdateResult	NormalProducer.update(List<Message> messageList) 批量更新消息 messageList TMQException

com.alibaba.tmq.client.system.producer.checker中Message的使用

参数类型为Message的com.alibaba.tmq.client.system.producer.checker中的方法

限定符和类型	方法和说明
TransactionStatus	LocalTransactionChecker.check(Message message) 检查消息 message

com.alibaba.tmq.client.system.producer.executer中Message的使用

参数类型为Message的com.alibaba.tmq.client.system.producer.executer中的方法

限定符和类型	方法和说明
Result<TransactionStatus>	TransactionProducerExecuter.check(Message message) 检查 message

com.alibaba.tmq.client.system.producer.implement中Message的使用

返回变量类型为Message的类型的com.alibaba.tmq.client.system.producer.implement中的方法

限定符和类型	方法和说明
List<Message>	DefaultProducer.get(Message message) 获取消息

参数类型为Message的com.alibaba.tmq.client.system.producer.implement中的方法

限定符和类型	方法和说明
DeleteResult	DefaultProducer.delete(Message message) 删除消息
List<Message>	DefaultProducer.get(Message message) 获取消息
SendResult	DefaultNormalProducer.send(Message message) 发送非事物消息
SendResult	DefaultTransactionProducer.send(Message message, LocalTransactionExecuter localTransactionExecuter, Object object) 发送事物消息
SubmitResult	DefaultNormalProducer.submit(Message message) 提交消息
UpdateResult	DefaultProducer.update(Message message) 更新消息

类型变量类型为Message的com.alibaba.tmq.client.system.producer.implement中的方法参数

限定符和类型	方法和说明
DeleteResult	DefaultProducer.delete(List<Message> messageList) 批量删除消息 messageList TMQException
SendResult	DefaultNormalProducer.send(List<Message> messageList) 批量发送非事物消息
SendResult	DefaultTransactionProducer.send(List<Message> messageList, LocalTransactionExecuter localTransactionExecuter, Object object) 批量发送事物消息
SubmitResult	DefaultNormalProducer.submit(List<? extends Message> messageList) 批量提交消息
Result<Boolean>	DefaultNormalProducer.submit(List<? extends Message> messageList, String server) 批量提交消息到server messageList server
UpdateResult	DefaultNormalProducer.update(List<Message> messageList) 批量更新消息
UpdateResult	DefaultProducer.updateMessageList(List<Message> messageList) 批量更新消息 messageList TMQException

com.alibaba.tmq.common.domain中Message的使用

com.alibaba.tmq.common.domain中Message的子类

限定符和类型	类和说明
class	CreateMessage 创建消息
class	DeleteMessage 删除消息
class	UpdateMessage 更新消息

返回Message的com.alibaba.tmq.common.domain中的方法

限定符和类型	方法和说明
static Message	Message.newInstance(String json) json转换成对象 json

参数类型为Message的com.alibaba.tmq.common.domain中的构造器

构造器和说明
MessageKey(Message message)

com.alibaba.tmq.common.domain.result中Message的使用

返回变量类型为Message的类型的com.alibaba.tmq.common.domain.result中的方法

限定符和类型	方法和说明
List<KeyValuePair<String,Message>>	UpdateResult.getMessageKeyValueList()
List<KeyValuePair<String,Message>>	SendResult.getMessageKeyValueList()
List<KeyValuePair<String,Message>>	SubmitResult.getMessageKeyValueList()

类型变量类型为Message的com.alibaba.tmq.common.domain.result中的方法参数

限定符和类型	方法和说明
void	UpdateResult.setMessageKeyValueList(List<KeyValuePair<String,Message>> messageKeyValueList)
void	SendResult.setMessageKeyValueList(List<KeyValuePair<String,Message>> messageKeyValueList)
void	SubmitResult.setMessageKeyValueList(List<KeyValuePair<String,Message>> messageKeyValueList)

类型变量类型为Message的com.alibaba.tmq.common.domain.result中的构造器参数

构造器和说明
SendResult(Boolean data, ResultCode resultCode, KeyValuePair<String,Message> messageKeyValue)
SendResult(Boolean data, ResultCode resultCode, List<KeyValuePair<String,Message>> messageKeyValueList)
SendResult(Result<Boolean> result, KeyValuePair<String,Message> messageKeyValue)
SendResult(Result<Boolean> result, List<KeyValuePair<String,Message>> messageKeyValueList)
SubmitResult(Boolean data, ResultCode resultCode, KeyValuePair<String,Message> messageKeyValue)
SubmitResult(Boolean data, ResultCode resultCode, List<KeyValuePair<String,Message>> messageKeyValueList)
SubmitResult(Result<Boolean> result, KeyValuePair<String,Message> messageKeyValue)
SubmitResult(Result<Boolean> result, List<KeyValuePair<String,Message>> messageKeyValueList)
UpdateResult(Boolean data, ResultCode resultCode, KeyValuePair<String,Message> messageKeyValue)
UpdateResult(Boolean data, ResultCode resultCode, List<KeyValuePair<String,Message>> messageKeyValueList)
UpdateResult(Result<Boolean> result, KeyValuePair<String,Message> messageKeyValue)
UpdateResult(Result<Boolean> result, List<KeyValuePair<String,Message>> messageKeyValueList)

com.alibaba.tmq.common.service中Message的使用

返回变量类型为Message的类型的com.alibaba.tmq.common.service中的方法

限定符和类型	方法和说明
List<Message>	ServerService.get(Message message) 获取消息 message

参数类型为Message的com.alibaba.tmq.common.service中的方法

限定符和类型	方法和说明
Result<TransactionStatus>	ClientService.check(ProducerKey producerKey, Message message) 事务消息检查 producerKey message
Result<Boolean>	ServerService.delete(Message message) 删除消息 message
List<Message>	ServerService.get(Message message) 获取消息 message
Result<Action>	ClientService.push(ConsumerKey consumerKey, Message message) 推送消息 consumerKey message
Result<Action>	ClientService.push(String consumerId, Message message) 推送消息 consumerId message
Result<Boolean>	ServerService.send(Message message) 发送消息 message
Result<Boolean>	ServerService.submit(Message message) 提交消息 message
Result<Boolean>	ServerService.update(Message message) 更新消息 message

类型变量类型为Message的com.alibaba.tmq.common.service中的方法参数

限定符和类型	方法和说明
Result<Boolean>	ServerService.delete(List<Message> messageList) 批量删除消息 messageList
Result<Boolean>	ServerService.send(List<Message> messageList) 批量发送消息 messageList
Result<Boolean>	ServerService.submit(List<? extends Message> messageList) 批量提交消息 messageList
Result<Boolean>	ServerService.update(List<Message> messageList) 批量更新消息 messageList

com.alibaba.tmq.common.util中Message的使用

返回Message的com.alibaba.tmq.common.util中的方法

限定符和类型	方法和说明
static Message	MessageUtil.retryClone(Message message) 重试复制消息 message

返回变量类型为Message的类型的com.alibaba.tmq.common.util中的方法

限定符和类型	方法和说明
static List<KeyValuePair<String,Message>>	MessageUtil.rendering(String producerId, List<? extends Message> messageList, MessageStatus status, MessageType messageType) 渲染消息列表 producerId messageList status messageType TMQException
static KeyValuePair<String,Message>	MessageUtil.rendering(String producerId, Message message, MessageStatus status, MessageType messageType) 渲染消息 producerId message status messageType TMQException
static List<KeyValuePair<String,Message>>	MessageUtil.renderingMessage(String producerId, List<Message> messageList, MessageStatus status, MessageType messageType) 渲染消息列表 producerId messageList status messageType TMQException
static KeyValuePair<String,Message>	MessageUtil.renderingMessage(String producerId, Message message, MessageStatus status, MessageType messageType) 渲染消息 producerId message status messageType TMQException

参数类型为Message的com.alibaba.tmq.common.util中的方法

限定符和类型	方法和说明
static String	IdAndKeyUtil.acquireUniqueKey(String messageId, Message message) 获取业务全局唯一Key messageId message TMQException
static Result<Boolean>	MessageUtil.check4Delete(Message message) 检查消息 message
static Result<Boolean>	MessageUtil.check4Get(Message message) 检查消息 message
static Result<Boolean>	MessageUtil.check4Send(Message message) 检查消息 message
static Result<Boolean>	MessageUtil.check4Update(Message message) 检查消息 message
static Result<Boolean>	MessageUtil.check4UpdateSingle(Message message) 检查消息 message
static Result<Boolean>	MessageUtil.checkMessage(MessageUtil messageUtil, Message message) 检查message messageUtil message
Result<Boolean>	MessageUtil.cronExpression(Message message, String cronExpression) 检查cronExpression message cronExpression
static void	MessageUtil.date2Seconds(Message message) 时间精确到秒 message
static void	LoggerUtil.info(Message message, String action, long startTime, String localAddress) 打印单条消息信息 message action startTime localAddress
static boolean	MessageUtil.isCompleteArguments(Message message) 判断是否完整消息参数 message
static KeyValuePair<String,Message>	MessageUtil.rendering(String producerId, Message message, MessageStatus status, MessageType messageType) 渲染消息 producerId message status messageType TMQException
static KeyValuePair<String,Message>	MessageUtil.renderingMessage(String producerId, Message message, MessageStatus status, MessageType messageType) 渲染消息 producerId message status messageType TMQException
static void	IdAndKeyUtil.renderingMessageKey(String producerId, Message message) 渲染MessageKey producerId message TMQException
static void	MessageUtil.reset(Message message, int clusterId) 重置参数 message clusterId
static Message	MessageUtil.retryClone(Message message) 重试复制消息 message
static void	MessageUtil.setMessageStatus(Message message, MessageStatus status) 设置消息状态 message status
static TracePoint	LoggerUtil.tracePoint(Message message, String action, long startTime, long cost, String localAddress)

类型变量类型为Message的com.alibaba.tmq.common.util中的方法参数

限定符和类型	方法和说明
static Result<Boolean>	MessageUtil.check4Delete(List<Message> messageList) 批量检查消息 messageList
static Result<Boolean>	MessageUtil.check4Send(List<Message> messageList) 批量检查消息 messageList
static Result<Boolean>	MessageUtil.check4Update(List<Message> messageList) 批量检查消息 messageList
static Result<Boolean>	MessageUtil.checkMessage(MessageUtil messageUtil, List<? extends Message> messageList) 检查messageList messageUtil messageList
static void	MessageUtil.date2Seconds(List<Message> messageList) 时间精确到秒 messageList
static void	LoggerUtil.info(List<? extends Message> messageList, String action, long startTime, String localAddress) 打印多条消息信息 messageList action startTime localAddress
static List<KeyValuePair<String,Message>>	MessageUtil.rendering(String producerId, List<? extends Message> messageList, MessageStatus status, MessageType messageType) 渲染消息列表 producerId messageList status messageType TMQException
static List<KeyValuePair<String,Message>>	MessageUtil.renderingMessage(String producerId, List<Message> messageList, MessageStatus status, MessageType messageType) 渲染消息列表 producerId messageList status messageType TMQException
static void	IdAndKeyUtil.renderingMessageKey(String producerId, List<Message> messageList) 批量渲染MessageKey producerId messageList TMQException
static void	MessageUtil.reset(List<? extends Message> messageList, int clusterId) 批量重置参数 messageList clusterId
static void	MessageUtil.setMessageStatus(List<Message> messageList, MessageStatus status) 批量设置消息状态 messageList status