org.jetlinks.core.device

接口 DeviceMessageSender

所有已知实现类:

DefaultDeviceMessageSender

public interface DeviceMessageSender

消息发送器,用于发送消息给设备.

从以下版本开始:

1.0.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
FunctionInvokeMessageSender	invokeFunction(String function) 发送FunctionInvokeMessage消息更便捷的API
ReadPropertyMessageSender	readProperty(String... property) 发送ReadPropertyMessage消息更便捷的API
<R extends DeviceMessage> reactor.core.publisher.Flux<R>	send(DeviceMessage message) 发送消息并获取返回
<R extends DeviceMessage> reactor.core.publisher.Flux<R>	send(org.reactivestreams.Publisher<? extends DeviceMessage> message, java.util.function.Function<Object,R> replyMapping) 发送消息并自定义返回结果转换器
<R extends DeviceMessageReply> reactor.core.publisher.Flux<R>	send(org.reactivestreams.Publisher<RepayableDeviceMessage<R>> message) 发送一个支持回复的消息.
default reactor.core.publisher.Mono<Void>	sendAndForget(DeviceMessage message) 发送消息后返回结果,不等待回复
WritePropertyMessageSender	writeProperty() 发送WritePropertyMessage消息更便捷的API

方法详细资料

send

<R extends DeviceMessageReply> reactor.core.publisher.Flux<R> send(org.reactivestreams.Publisher<RepayableDeviceMessage<R>> message)

发送一个支持回复的消息.

⚠️: 请勿自己实现消息对象,而应该使用框架定义的3种消息. ⚠️: 如果是异步消息,将直接返回{"success":true,"code":"REQUEST_HANDLING"}

类型参数:

R - 返回类型

参数:

message - 具体的消息对象

返回:

异步发送结果

另请参阅:

ReadPropertyMessage, ReadPropertyMessageReply, WritePropertyMessage, WritePropertyMessageReply, FunctionInvokeMessage, FunctionInvokeMessageReply, ErrorCode.CLIENT_OFFLINE, ErrorCode.REQUEST_HANDLING, DeviceMessageSenderInterceptor

send

<R extends DeviceMessage> reactor.core.publisher.Flux<R> send(org.reactivestreams.Publisher<? extends DeviceMessage> message,
                                                              java.util.function.Function<Object,R> replyMapping)

发送消息并自定义返回结果转换器

类型参数:

R - 回复类型

参数:

message - 消息

replyMapping - 消息回复转换器

返回:

异步发送结果

另请参阅:

send(Publisher)

send

<R extends DeviceMessage> reactor.core.publisher.Flux<R> send(DeviceMessage message)

发送消息并获取返回

类型参数:

R - 回复类型

参数:

message - 消息

返回:

异步发送结果

另请参阅:

send(Publisher)

sendAndForget

default reactor.core.publisher.Mono<Void> sendAndForget(DeviceMessage message)

发送消息后返回结果,不等待回复

参数:

message - 消息

返回:

void

从以下版本开始:

1.1.5

invokeFunction

FunctionInvokeMessageSender invokeFunction(String function)

发送FunctionInvokeMessage消息更便捷的API

参数:

function - 要执行的功能

返回:

FunctionInvokeMessageSender

另请参阅:

send(Publisher), FunctionInvokeMessage, FunctionInvokeMessageSender

readProperty

ReadPropertyMessageSender readProperty(String... property)

发送ReadPropertyMessage消息更便捷的API

参数:

property - 要获取的属性列表

返回:

ReadPropertyMessageSender

另请参阅:

send(Publisher), ReadPropertyMessage, ReadPropertyMessageSender

writeProperty

WritePropertyMessageSender writeProperty()

发送WritePropertyMessage消息更便捷的API

返回:

WritePropertyMessageSender

另请参阅:

send(Publisher), WritePropertyMessage, WritePropertyMessageSender