org.jetlinks.core.device

接口 DeviceRegistry

public interface DeviceRegistry

设备注册中心,用于统一管理设备以及产品的基本信息,缓存,进行设备指令下发等操作. 例如获取设备以及设备的配置缓存信息:

    registry
    .getDevice(deviceId)
    .flatMap(device->device.getSelfConfig("my-config"))
    .flatMap(conf-> doSomeThing(...))
 

从以下版本开始:

1.0.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
default reactor.core.publisher.Flux<DeviceStateInfo>	checkDeviceState(reactor.core.publisher.Flux<? extends Collection<String>> id) 批量检查设备真实状态,建议使用DeviceOperator.checkState()
reactor.core.publisher.Mono<DeviceOperator>	getDevice(String deviceId) 获取设备操作接口.如果设备未注册或者注册已失效(缓存丢失).则回返回Mono.empty(), 可以通过Mono.switchIfEmpty(Mono)来处理设备不存在的情况.如: registry .getDevice(deviceId) .switchIfEmpty(Mono.error(()->new DeviceNotFoundException(....)))
reactor.core.publisher.Mono<DeviceProductOperator>	getProduct(String productId) 获取设备产品操作,请勿缓存返回值,注册中心已经实现本地缓存.
default reactor.core.publisher.Mono<DeviceProductOperator>	getProduct(String productId, String version) 获取指定版本的产品,在注册产品时,指定了产品版本ProductInfo#getVersion()的信息,可以通过此方法获取
reactor.core.publisher.Mono<DeviceOperator>	register(DeviceInfo deviceInfo) 注册设备,并返回设备操作接口,请勿缓存返回值,注册中心已经实现本地缓存.
reactor.core.publisher.Mono<DeviceProductOperator>	register(ProductInfo productInfo) 注册产品(型号)信息
reactor.core.publisher.Mono<Void>	unregisterDevice(String deviceId) 注销设备,注销后将无法通过getDevice(String)获取到设备信息, 此操作将触发ProtocolSupport.onDeviceUnRegister(DeviceOperator)
reactor.core.publisher.Mono<Void>	unregisterProduct(String productId) 注销产品,注销后将无法通过getProduct(String) 获取到产品信息 此操作只会注销未设置版本的产品.
default reactor.core.publisher.Mono<Void>	unregisterProduct(String productId, String version) 注销指定版本的产品,注销后将无法通过getProduct(String,String) 获取到产品信息 此操作将触发ProtocolSupport.onProductUnRegister(DeviceProductOperator)

方法详细资料

getDevice

reactor.core.publisher.Mono<DeviceOperator> getDevice(String deviceId)

获取设备操作接口.如果设备未注册或者注册已失效(缓存丢失).则回返回Mono.empty(), 可以通过Mono.switchIfEmpty(Mono)来处理设备不存在的情况.如:

     registry
     .getDevice(deviceId)
     .switchIfEmpty(Mono.error(()->new DeviceNotFoundException(....)))
 

参数:

deviceId - 设备ID

返回:

设备操作接口

checkDeviceState

default reactor.core.publisher.Flux<DeviceStateInfo> checkDeviceState(reactor.core.publisher.Flux<? extends Collection<String>> id)

批量检查设备真实状态,建议使用DeviceOperator.checkState()

参数:

id - ID

返回:

设备状态信息流

getProduct

reactor.core.publisher.Mono<DeviceProductOperator> getProduct(String productId)

获取设备产品操作,请勿缓存返回值,注册中心已经实现本地缓存.

参数:

productId - 产品ID

返回:

产品操作接口

getProduct

default reactor.core.publisher.Mono<DeviceProductOperator> getProduct(String productId,
                                                                      String version)

获取指定版本的产品,在注册产品时,指定了产品版本ProductInfo#getVersion()的信息,可以通过此方法获取

参数:

productId - 产品ID

version - 版本号

返回:

对应版本的产品

从以下版本开始:

1.1.9

register

reactor.core.publisher.Mono<DeviceOperator> register(DeviceInfo deviceInfo)

注册设备,并返回设备操作接口,请勿缓存返回值,注册中心已经实现本地缓存.

参数:

deviceInfo - 设备基础信息

返回:

设备操作接口

另请参阅:

getDevice(String)

register

reactor.core.publisher.Mono<DeviceProductOperator> register(ProductInfo productInfo)

注册产品(型号)信息

参数:

productInfo - 产品(型号)信息

返回:

注册结果

unregisterDevice

reactor.core.publisher.Mono<Void> unregisterDevice(String deviceId)

注销设备,注销后将无法通过getDevice(String)获取到设备信息, 此操作将触发ProtocolSupport.onDeviceUnRegister(DeviceOperator)

参数:

deviceId - 设备ID

返回:

void

unregisterProduct

reactor.core.publisher.Mono<Void> unregisterProduct(String productId)

注销产品,注销后将无法通过getProduct(String) 获取到产品信息
此操作只会注销未设置版本的产品.
此操作将触发ProtocolSupport.onProductUnRegister(DeviceProductOperator)

参数:

productId - 产品ID

返回:

void

unregisterProduct

default reactor.core.publisher.Mono<Void> unregisterProduct(String productId,
                                                            String version)

注销指定版本的产品,注销后将无法通过getProduct(String,String) 获取到产品信息
此操作将触发ProtocolSupport.onProductUnRegister(DeviceProductOperator)

参数:

productId - 产品ID

version - 版本号

返回:

void

从以下版本开始:

1.1.9