接口的使用
org.jetlinks.core.device.DeviceOperator

使用DeviceOperator的程序包

程序包	说明
org.jetlinks.core
org.jetlinks.core.defaults
org.jetlinks.core.device
org.jetlinks.core.message.codec
org.jetlinks.core.message.interceptor
org.jetlinks.core.server
org.jetlinks.core.server.session

org.jetlinks.core中DeviceOperator的使用

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

限定符和类型	方法和说明
reactor.core.publisher.Mono<AuthenticationResponse>	ProtocolSupport.authenticate(AuthenticationRequest request, DeviceOperator deviceOperation) 进行设备认证
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动绑定子设备到网关设备
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动接触绑定子设备到网关设备
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onDeviceMetadataChanged(DeviceOperator operator) 当设备物模型变更时调用
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onDeviceRegister(DeviceOperator operator) 当设备注册生效后调用
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onDeviceUnRegister(DeviceOperator operator) 当设备注销前调用

类型变量类型为DeviceOperator的org.jetlinks.core中的方法参数

限定符和类型	方法和说明
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动绑定子设备到网关设备
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动接触绑定子设备到网关设备

org.jetlinks.core.defaults中DeviceOperator的使用

实现DeviceOperator的org.jetlinks.core.defaults中的类

限定符和类型	类和说明
class	DefaultDeviceOperator

返回变量类型为DeviceOperator的类型的org.jetlinks.core.defaults中的方法

限定符和类型	方法和说明
reactor.core.publisher.Flux<DeviceOperator>	DefaultDeviceProductOperator.getDevices()

参数类型为DeviceOperator的org.jetlinks.core.defaults中的方法

限定符和类型	方法和说明
reactor.core.publisher.Mono<AuthenticationResponse>	Authenticator.authenticate(AuthenticationRequest request, DeviceOperator device) 对指定对设备进行认证
reactor.core.publisher.Mono<AuthenticationResponse>	CompositeProtocolSupport.authenticate(AuthenticationRequest request, DeviceOperator deviceOperation)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onDeviceMetadataChanged(DeviceOperator operator)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onDeviceRegister(DeviceOperator operator)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onDeviceUnRegister(DeviceOperator operator)

类型变量类型为DeviceOperator的org.jetlinks.core.defaults中的方法参数

限定符和类型	方法和说明
void	CompositeProtocolSupport.doOnChildBind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildBind)
void	CompositeProtocolSupport.doOnChildBind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildBind)
void	CompositeProtocolSupport.doOnChildUnbind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildUnbind)
void	CompositeProtocolSupport.doOnChildUnbind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildUnbind)
CompositeProtocolSupport	CompositeProtocolSupport.doOnDeviceMetadataChanged(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	CompositeProtocolSupport.doOnDeviceRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	CompositeProtocolSupport.doOnDeviceUnRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child)
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child)

参数类型为DeviceOperator的org.jetlinks.core.defaults中的构造器

构造器和说明
DefaultDeviceMessageSender(DeviceOperationBroker handler, DeviceOperator operator, DeviceRegistry registry, DeviceMessageSenderInterceptor interceptor)
DefaultFunctionInvokeMessageSender(DeviceOperator operator, String functionId)
DefaultReadPropertyMessageSender(DeviceOperator operator)
DefaultWritePropertyMessageSender(DeviceOperator operator)

类型变量类型为DeviceOperator的org.jetlinks.core.defaults中的构造器参数

构造器和说明
DefaultDeviceProductOperator(String id, ProtocolSupports supports, ConfigStorageManager manager, java.util.function.Supplier<reactor.core.publisher.Flux<DeviceOperator>> supplier)
DefaultDeviceProductOperator(String id, ProtocolSupports supports, reactor.core.publisher.Mono<ConfigStorage> storageMono, java.util.function.Supplier<reactor.core.publisher.Flux<DeviceOperator>> supplier)

org.jetlinks.core.device中DeviceOperator的使用

返回变量类型为DeviceOperator的类型的org.jetlinks.core.device中的方法

限定符和类型	方法和说明
reactor.core.publisher.Mono<DeviceOperator>	DeviceRegistry.getDevice(String deviceId) 获取设备操作接口.如果设备未注册或者注册已失效(缓存丢失).则回返回Mono.empty(), 可以通过Mono.switchIfEmpty(Mono)来处理设备不存在的情况.如: registry .getDevice(deviceId) .switchIfEmpty(Mono.error(()->new DeviceNotFoundException(....)))
reactor.core.publisher.Flux<DeviceOperator>	DeviceProductOperator.getDevices()
reactor.core.publisher.Mono<DeviceOperator>	DeviceRegistry.register(DeviceInfo deviceInfo) 注册设备,并返回设备操作接口,请勿缓存返回值,注册中心已经实现本地缓存.

参数类型为DeviceOperator的org.jetlinks.core.device中的方法

限定符和类型	方法和说明
<R extends DeviceMessage> reactor.core.publisher.Flux<R>	CompositeDeviceMessageSenderInterceptor.afterSent(DeviceOperator device, DeviceMessage message, reactor.core.publisher.Flux<R> reply)
@NotNull reactor.core.publisher.Mono<Byte>	DeviceStateChecker.checkState(@NotNull DeviceOperator device) 检查设备状态
reactor.core.publisher.Flux<DeviceMessage>	CompositeDeviceMessageSenderInterceptor.doSend(DeviceOperator device, DeviceMessage source, reactor.core.publisher.Flux<DeviceMessage> sender)
reactor.core.publisher.Mono<DeviceMessage>	CompositeDeviceMessageSenderInterceptor.preSend(DeviceOperator device, DeviceMessage message)

org.jetlinks.core.message.codec中DeviceOperator的使用

返回DeviceOperator的org.jetlinks.core.message.codec中的方法

限定符和类型	方法和说明
DeviceOperator	MessageCodecContext.getDevice() 获取当前上下文中到设备操作接口, 在tcp,http等场景下,此接口可能返回null
default DeviceOperator	FromDeviceMessageContext.getDevice()

返回变量类型为DeviceOperator的类型的org.jetlinks.core.message.codec中的方法

限定符和类型	方法和说明
default reactor.core.publisher.Mono<DeviceOperator>	MessageCodecContext.getDevice(String deviceId) 获取指定设备的操作接口.
default reactor.core.publisher.Mono<DeviceOperator>	MessageCodecContext.getDeviceAsync() 同MessageCodecContext.getDevice(),只是返回结果是Mono,不会为null.

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

限定符和类型	方法和说明
default ToDeviceMessageContext	ToDeviceMessageContext.mutate(Message anotherMessage, DeviceOperator device) 使用新的消息和设备，转换为新上下文.
default MessageEncodeContext	MessageEncodeContext.mutate(Message anotherMessage, DeviceOperator device) 使用新的消息和设备，转换为新上下文

org.jetlinks.core.message.interceptor中DeviceOperator的使用

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

限定符和类型	方法和说明
default <R extends DeviceMessage> reactor.core.publisher.Flux<R>	DeviceMessageSenderInterceptor.afterSent(DeviceOperator device, DeviceMessage message, reactor.core.publisher.Flux<R> reply) 在消息发送后触发.这里发送后并不是真正的发送，其实只是构造了整个发送的逻辑流Flux(参数 reply),
default reactor.core.publisher.Flux<DeviceMessage>	DeviceMessageSenderInterceptor.doSend(DeviceOperator device, DeviceMessage source, reactor.core.publisher.Flux<DeviceMessage> sender) 执行发送时触发.
default reactor.core.publisher.Mono<DeviceMessage>	DeviceMessageSenderInterceptor.preSend(DeviceOperator device, DeviceMessage message) 在消息发送前触发.

org.jetlinks.core.server中DeviceOperator的使用

返回变量类型为DeviceOperator的类型的org.jetlinks.core.server中的方法

限定符和类型	方法和说明
reactor.core.publisher.Mono<DeviceOperator>	DeviceGatewayContext.getDevice(String deviceId) 根据ID获取设备操作接口

org.jetlinks.core.server.session中DeviceOperator的使用

返回DeviceOperator的org.jetlinks.core.server.session中的方法

限定符和类型	方法和说明
DeviceOperator	KeepOnlineSession.getOperator()
DeviceOperator	DeviceSession.getOperator() 获取设备操作对象,在类似TCP首次请求的场景下,返回值可能为null.
DeviceOperator	ChildrenDeviceSession.getParentDevice()

参数类型为DeviceOperator的org.jetlinks.core.server.session中的构造器

构造器和说明
ChildrenDeviceSession(String deviceId, DeviceSession parent, DeviceOperator operator)