org.jetlinks.core.message

接口 FunctionInvokeMessageSender

所有已知实现类:

DefaultFunctionInvokeMessageSender

public interface FunctionInvokeMessageSender

调用设备功能的消息发送器

从以下版本开始:

1.0.0

作者:

zhouhao

另请参阅:

DeviceMessageSender, FunctionInvokeMessage, FunctionInvokeMessageReply

方法概要

限定符和类型	方法和说明
default FunctionInvokeMessageSender	accept(java.util.function.Consumer<FunctionInvokeMessageSender> consumer)
FunctionInvokeMessageSender	addParameter(FunctionParameter parameter)
default FunctionInvokeMessageSender	addParameter(String name, Object value)
default FunctionInvokeMessageSender	async() 设置调用此功能为异步执行, 当消息发送到设备后,立即返回ErrorCode.REQUEST_HANDLING,而不等待设备返回结果.
default FunctionInvokeMessageSender	async(Boolean async) 设置是否异步
FunctionInvokeMessageSender	custom(java.util.function.Consumer<FunctionInvokeMessage> messageConsumer)
default <T> FunctionInvokeMessageSender	header(HeaderKey<T> header, T value)
FunctionInvokeMessageSender	header(String header, Object value)
default FunctionInvokeMessageSender	headers(Map<String,Object> headers) 添加多个header到message中
FunctionInvokeMessageSender	messageId(String messageId)
reactor.core.publisher.Flux<FunctionInvokeMessageReply>	send() 发送消息
default reactor.core.publisher.Mono<Void>	sendAndForget() 异步发送,并忽略返回结果
FunctionInvokeMessageSender	setParameter(List<FunctionParameter> parameter)
default FunctionInvokeMessageSender	setParameter(Map<String,Object> parameter)
default FunctionInvokeMessageSender	timeout(java.time.Duration timeout)
reactor.core.publisher.Mono<FunctionInvokeMessageSender>	validate() 执行参数校验 function("door-open") .validate() .flatMany(FunctionInvokeMessageSender::send) .doOnError(IllegalParameterException.class,err->log.error(err.getMessage(),err)) ...

方法详细资料

custom

FunctionInvokeMessageSender custom(java.util.function.Consumer<FunctionInvokeMessage> messageConsumer)

header

FunctionInvokeMessageSender header(String header,
                                   Object value)

addParameter

FunctionInvokeMessageSender addParameter(FunctionParameter parameter)

setParameter

FunctionInvokeMessageSender setParameter(List<FunctionParameter> parameter)

messageId

FunctionInvokeMessageSender messageId(String messageId)

validate

reactor.core.publisher.Mono<FunctionInvokeMessageSender> validate()

执行参数校验

     function("door-open")
     .validate()
     .flatMany(FunctionInvokeMessageSender::send)
     .doOnError(IllegalParameterException.class,err->log.error(err.getMessage(),err))
     ...
 

另请参阅:

Mono.doOnError(Consumer), IllegalParameterException, FunctionUndefinedException, FunctionIllegalParameterException

send

reactor.core.publisher.Flux<FunctionInvokeMessageReply> send()

发送消息

返回:

返回结果

另请参阅:

DeviceOperationException, ErrorCode.CLIENT_OFFLINE

sendAndForget

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

异步发送,并忽略返回结果

返回:

void

accept

default FunctionInvokeMessageSender accept(java.util.function.Consumer<FunctionInvokeMessageSender> consumer)

addParameter

default FunctionInvokeMessageSender addParameter(String name,
                                                 Object value)

setParameter

default FunctionInvokeMessageSender setParameter(Map<String,Object> parameter)

timeout

default FunctionInvokeMessageSender timeout(java.time.Duration timeout)

async

default FunctionInvokeMessageSender async()

设置调用此功能为异步执行, 当消息发送到设备后,立即返回ErrorCode.REQUEST_HANDLING,而不等待设备返回结果. {"success":true,"code":"REQUEST_HANDLING"}

返回:

this

另请参阅:

Headers.async

async

default FunctionInvokeMessageSender async(Boolean async)

设置是否异步

参数:

async - 是否异步

返回:

this

另请参阅:

async(Boolean), Headers.async

header

default <T> FunctionInvokeMessageSender header(HeaderKey<T> header,
                                               T value)

headers

default FunctionInvokeMessageSender headers(Map<String,Object> headers)

添加多个header到message中

参数:

headers - 多个headers

返回:

this

另请参阅:

header(String, Object), DeviceMessage.addHeader(String, Object), Headers