接口的使用
org.jetlinks.core.message.HeaderKey

使用HeaderKey的程序包

程序包	说明
org.jetlinks.core.message

org.jetlinks.core.message中HeaderKey的使用

声明为HeaderKey的org.jetlinks.core.message中的字段

限定符和类型	字段和说明
static HeaderKey<Boolean>	Headers.async 异步消息,当发往设备的消息标记了为异步时,设备网关服务发送消息到设备后将立即回复ErrorCode.REQUEST_HANDLING到发送端
static HeaderKey<String>	Headers.clientAddress 客户端地址,通常为设备IP地址
static HeaderKey<Boolean>	Headers.dispatchToParent 是否为转发到父设备的消息
static HeaderKey<Boolean>	Headers.enableTrace 是否开启追踪,开启后header中将添加各个操作的时间戳
static HeaderKey<Boolean>	Headers.force 强制执行
static HeaderKey<String>	Headers.fragmentBodyMessageId
static HeaderKey<Boolean>	Headers.fragmentLast
static HeaderKey<Integer>	Headers.fragmentNumber
static HeaderKey<Integer>	Headers.fragmentPart
static HeaderKey<String>	Headers.geoProperty 明确定义上报属性中包含的geo属性字段,在设备物模型属性数量较大时有助于提升地理位置信息处理性能
static HeaderKey<Boolean>	Headers.ignore 忽略某些操作,具体由不同的消息决定
static HeaderKey<Boolean>	Headers.ignoreLog 忽略记录日志
static HeaderKey<Boolean>	Headers.ignoreSession 忽略会话创建,如果设备未在线,默认为创建会话,设置此header为true后则不会自动创建会话.
static HeaderKey<Boolean>	Headers.ignoreStorage 标记数据不存储
static HeaderKey<Boolean>	Headers.keepOnline 保持在线,与DeviceOnlineMessage配合使用.
static HeaderKey<Integer>	Headers.keepOnlineTimeoutSeconds 保持在线超时时间,超过指定时间未收到消息则认为离线
static HeaderKey<Boolean>	Headers.mergeLatest 是否合并历史属性数据,设置此消息头后,将会把历史最新的消息合并到消息体里
static HeaderKey<Boolean>	Headers.partialProperties
static HeaderKey<String>	Headers.productId 产品ID
static HeaderKey<Boolean>	Headers.propertyContainsGeo 上报属性中是否包含geo信息,如果设置为false,上报属性时则不处理地理位置相关逻辑,可能提高一些性能
static HeaderKey<String>	Headers.replyFrom
static HeaderKey<Boolean>	Headers.sendAndForget 发送既不管
static HeaderKey<String>	Headers.sendFrom
static HeaderKey<Long>	Headers.timeout 指定发送消息的超时时间
static HeaderKey<Boolean>	Headers.useTimestampAsId

返回HeaderKey的org.jetlinks.core.message中的方法

限定符和类型	方法和说明
static <T> HeaderKey<T>	HeaderKey.of(String key, T defaultValue)
static <T> HeaderKey<T>	HeaderKey.of(String key, T defaultValue, Class<T> type)

参数类型为HeaderKey的org.jetlinks.core.message中的方法

限定符和类型	方法和说明
<T> SELF	CommonThingMessageReply.addHeader(HeaderKey<T> header, T value)
default <T> ThingMessageReply	ThingMessageReply.addHeader(@NotNull HeaderKey<T> header, T value)
default <T> Message	Message.addHeader(HeaderKey<T> header, T value)
default <T> DeviceMessageReply	DeviceMessageReply.addHeader(@NotNull HeaderKey<T> header, T value)
<T> ME	CommonDeviceMessageReply.addHeader(HeaderKey<T> header, T value)
default <T> DeviceMessage	DeviceMessage.addHeader(HeaderKey<T> header, T value)
default <T> Message	Message.addHeaderIfAbsent(HeaderKey<T> header, T value)
default <T> DeviceMessage	DeviceMessage.addHeaderIfAbsent(HeaderKey<T> header, T value)
default <T> T	Message.computeHeader(HeaderKey<T> key, java.util.function.BiFunction<String,T,T> computer)
default <T> Optional<T>	Message.getHeader(HeaderKey<T> key)
default <T> T	Message.getHeaderOrDefault(HeaderKey<T> key)
default <T> T	Message.getHeaderOrElse(HeaderKey<T> header, java.util.function.Supplier<T> orElse)
default <T> T	Message.getOrAddHeader(HeaderKey<T> header, java.util.function.Supplier<T> value)
default <T> T	Message.getOrAddHeaderDefault(HeaderKey<T> header)
default <T> WritePropertyMessageSender	WritePropertyMessageSender.header(HeaderKey<T> header, T value)
default <T> ReadPropertyMessageSender	ReadPropertyMessageSender.header(HeaderKey<T> header, T value)
default <T> FunctionInvokeMessageSender	FunctionInvokeMessageSender.header(HeaderKey<T> header, T value)