org.jetlinks.core.message

接口 Message

所有超级接口:

Jsonable, Serializable

所有已知子接口:

BroadcastMessage, DeviceMessage, DeviceMessageReply, ReadThingPropertyMessage<T>, ReadThingPropertyMessageReply, RepayableDeviceMessage<R>, RepayableThingMessage<R>, ThingEventMessage, ThingFunctionInvokeMessage<R>, ThingFunctionInvokeMessageReply, ThingMessage, ThingMessageReply, ThingReportPropertyMessage, UpdateTingTagsMessage, WriteThingPropertyMessage<T>, WriteThingPropertyMessageReply

所有已知实现类:

AcknowledgeDeviceMessage, ChildDeviceMessage, ChildDeviceMessageReply, CommonDeviceMessage, CommonDeviceMessageReply, CommonThingMessage, CommonThingMessageReply, DefaultBroadcastMessage, DefaultEventMessage, DefaultFunctionInvokeMessage, DefaultFunctionInvokeMessageReply, DefaultReadPropertyMessage, DefaultReadPropertyMessageReply, DefaultReportPropertyMessage, DefaultUpdateTingTagsMessage, DefaultWritePropertyMessage, DefaultWritePropertyMessageReply, DerivedMetadataMessage, DeviceLogMessage, DeviceOfflineMessage, DeviceOnlineMessage, DeviceRegisterMessage, DeviceStateCheckMessage, DeviceStateCheckMessageReply, DeviceUnRegisterMessage, DirectDeviceMessage, DisconnectDeviceMessage, DisconnectDeviceMessageReply, EventMessage, FunctionInvokeMessage, FunctionInvokeMessageReply, ReadFirmwareMessage, ReadFirmwareMessageReply, ReadPropertyMessage, ReadPropertyMessageReply, ReportFirmwareMessage, ReportPropertyMessage, RequestFirmwareMessage, RequestFirmwareMessageReply, UpdateTagMessage, UpgradeFirmwareMessage, UpgradeFirmwareMessageReply, UpgradeFirmwareProgressMessage, WritePropertyMessage, WritePropertyMessageReply

public interface Message
extends Jsonable, Serializable

设备消息

另请参阅:

ReadPropertyMessage, ReadPropertyMessageReply, WritePropertyMessage, WritePropertyMessageReply, FunctionInvokeMessage, FunctionInvokeMessageReply, EventMessage, DeviceOnlineMessage, DeviceOfflineMessage, ChildDeviceMessage, ChildDeviceMessageReply

方法概要

限定符和类型	方法和说明
default <T> Message	addHeader(HeaderKey<T> header, T value)
Message	addHeader(String header, Object value) 添加一个header
default <T> Message	addHeaderIfAbsent(HeaderKey<T> header, T value)
Message	addHeaderIfAbsent(String header, Object value) 添加header,如果header已存在则放弃
default <T> T	computeHeader(HeaderKey<T> key, java.util.function.BiFunction<String,T,T> computer)
Object	computeHeader(String key, java.util.function.BiFunction<String,Object,Object> computer)
default Message	copy()
default <T> Optional<T>	getHeader(HeaderKey<T> key)
default Optional<Object>	getHeader(String header)
default <T> T	getHeaderOrDefault(HeaderKey<T> key)
default <T> T	getHeaderOrElse(HeaderKey<T> header, java.util.function.Supplier<T> orElse)
default Object	getHeaderOrElse(String header, java.util.function.Supplier<Object> orElse)
Map<String,Object>	getHeaders() 消息头,用于自定义一些消息行为, 默认的一些消息头请看:Headers
String	getMessageId() 消息的唯一标识,用于在请求响应模式下对请求和响应进行关联.
default MessageType	getMessageType()
default <T> T	getOrAddHeader(HeaderKey<T> header, java.util.function.Supplier<T> value)
default <T> T	getOrAddHeaderDefault(HeaderKey<T> header)
long	getTimestamp()
Message	removeHeader(String header) 删除一个header
default void	validate()

从接口继承的方法 org.jetlinks.core.metadata.Jsonable

fromJson, toJson

方法详细资料

getMessageType

default MessageType getMessageType()

getMessageId

String getMessageId()

消息的唯一标识,用于在请求响应模式下对请求和响应进行关联.

注意: 此消息ID为全系统唯一. 但是在很多情况下,设备可能不支持此类型的消息ID, 此时需要在协议包中做好映射关系,比如使用:ConcurrentHashMap进行消息绑定. 还可以使用工具类:CodecContext来进行此操作.

返回:

消息ID

getTimestamp

long getTimestamp()

返回:

毫秒时间戳

另请参阅:

System.currentTimeMillis()

getHeaders

@Nullable
Map<String,Object> getHeaders()

消息头,用于自定义一些消息行为, 默认的一些消息头请看:Headers

返回:

headers or null

另请参阅:

Headers

addHeader

Message addHeader(String header,
                  Object value)

添加一个header

参数:

header - header

value - value

返回:

this

另请参阅:

Headers

addHeaderIfAbsent

Message addHeaderIfAbsent(String header,
                          Object value)

添加header,如果header已存在则放弃

参数:

header - header key

value - header 值

返回:

this

removeHeader

Message removeHeader(String header)

删除一个header

参数:

header - header

返回:

this

另请参阅:

Headers

addHeader

default <T> Message addHeader(HeaderKey<T> header,
                              T value)

另请参阅:

Headers, addHeader(String, Object)

addHeaderIfAbsent

default <T> Message addHeaderIfAbsent(HeaderKey<T> header,
                                      T value)

另请参阅:

Headers, addHeaderIfAbsent(String, Object)

getOrAddHeader

default <T> T getOrAddHeader(HeaderKey<T> header,
                             java.util.function.Supplier<T> value)

getOrAddHeaderDefault

default <T> T getOrAddHeaderDefault(HeaderKey<T> header)

getHeader

default <T> Optional<T> getHeader(HeaderKey<T> key)

getHeaderOrDefault

default <T> T getHeaderOrDefault(HeaderKey<T> key)

getHeaderOrElse

default <T> T getHeaderOrElse(HeaderKey<T> header,
                              @Nullable
                              java.util.function.Supplier<T> orElse)

getHeaderOrElse

default Object getHeaderOrElse(String header,
                               @Nullable
                               java.util.function.Supplier<Object> orElse)

getHeader

default Optional<Object> getHeader(String header)

computeHeader

Object computeHeader(String key,
                     java.util.function.BiFunction<String,Object,Object> computer)

computeHeader

default <T> T computeHeader(HeaderKey<T> key,
                            java.util.function.BiFunction<String,T,T> computer)

validate

default void validate()

copy

default Message copy()