接口的使用
org.jetlinks.core.message.codec.Transport

使用Transport的程序包

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

org.jetlinks.core中Transport的使用

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

限定符和类型	方法和说明
reactor.core.publisher.Flux<? extends Transport>	ProtocolSupport.getSupportedTransport()

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

限定符和类型	方法和说明
default reactor.core.publisher.Mono<DeviceInfo>	ProtocolSupport.doBeforeDeviceCreate(Transport transport, DeviceInfo deviceInfo) 在执行设备创建之前,执行指定的操作。
default reactor.core.publisher.Mono<ConfigMetadata>	ProtocolSupport.getConfigMetadata(Transport transport) 获取协议所需的配置信息定义
default reactor.core.publisher.Mono<DeviceMetadata>	ProtocolSupport.getDefaultMetadata(Transport transport) 获取默认物模型
default reactor.core.publisher.Flux<Feature>	ProtocolSupport.getFeatures(Transport transport) 获取协议支持的某些自定义特性
reactor.core.publisher.Mono<? extends DeviceMessageCodec>	ProtocolSupport.getMessageCodec(Transport transport) 获取设备消息编码解码器 用于将平台统一的消息对象转码为设备的消息 用于将设备发送的消息转吗为平台统一的消息对象
default reactor.core.publisher.Flux<ConfigMetadata>	ProtocolSupport.getMetadataExpandsConfig(Transport transport, DeviceMetadataType metadataType, String metadataId, String dataTypeId) 获取物模型拓展配置定义
default reactor.core.publisher.Mono<Void>	ProtocolSupport.onClientConnect(Transport transport, ClientConnection connection, DeviceGatewayContext context) 客户端创建连接时调用,返回设备ID,表示此设备上线.

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

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

限定符和类型	方法和说明
reactor.core.publisher.Flux<Transport>	CompositeProtocolSupport.getSupportedTransport()

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

限定符和类型	方法和说明
void	CompositeProtocolSupport.addAuthenticator(Transport transport, Authenticator authenticator)
void	CompositeProtocolSupport.addConfigMetadata(Transport transport, ConfigMetadata metadata)
void	CompositeProtocolSupport.addConfigMetadata(Transport transport, java.util.function.Supplier<reactor.core.publisher.Mono<ConfigMetadata>> metadata)
void	CompositeProtocolSupport.addDefaultMetadata(Transport transport, DeviceMetadata metadata)
void	CompositeProtocolSupport.addDefaultMetadata(Transport transport, reactor.core.publisher.Mono<DeviceMetadata> metadata)
void	CompositeProtocolSupport.addFeature(Transport transport, Feature... features) 给指定的Transport添加Feature
void	CompositeProtocolSupport.addFeature(Transport transport, reactor.core.publisher.Flux<Feature> features) 给指定的Transport添加Feature
void	CompositeProtocolSupport.addFeature(Transport transport, Iterable<Feature> features) 给指定的Transport添加Feature
void	CompositeProtocolSupport.addMessageCodecSupport(Transport transport, DeviceMessageCodec codec)
void	CompositeProtocolSupport.addMessageCodecSupport(Transport transport, java.util.function.Supplier<reactor.core.publisher.Mono<DeviceMessageCodec>> supplier)
reactor.core.publisher.Mono<DeviceInfo>	CompositeProtocolSupport.doBeforeDeviceCreate(Transport transport, DeviceInfo deviceInfo)
void	CompositeProtocolSupport.doOnClientConnect(Transport transport, java.util.function.BiFunction<ClientConnection,DeviceGatewayContext,reactor.core.publisher.Mono<Void>> handler) 监听客户端连接,只有部分协议支持此操作,如: support.doOnClientConnect(TCP,(connection,context)->{ //客户端创建连接时,发送消息给客户端 return connection .sendMessage(createHelloMessage()) .then(); })
reactor.core.publisher.Mono<ConfigMetadata>	CompositeProtocolSupport.getConfigMetadata(Transport transport)
reactor.core.publisher.Mono<DeviceMetadata>	CompositeProtocolSupport.getDefaultMetadata(Transport transport)
reactor.core.publisher.Flux<Feature>	CompositeProtocolSupport.getFeatures(Transport transport)
reactor.core.publisher.Mono<? extends DeviceMessageCodec>	CompositeProtocolSupport.getMessageCodec(Transport transport)
reactor.core.publisher.Flux<ConfigMetadata>	CompositeProtocolSupport.getMetadataExpandsConfig(Transport transport, DeviceMetadataType metadataType, String metadataId, String dataTypeId)
void	CompositeProtocolSupport.onBeforeDeviceCreate(Transport transport, java.util.function.Function<DeviceInfo,reactor.core.publisher.Mono<DeviceInfo>> listener) 注册设备添加监听器,用于在创建设备时,进行自定义配置生成等操作.
reactor.core.publisher.Mono<Void>	CompositeProtocolSupport.onClientConnect(Transport transport, ClientConnection connection, DeviceGatewayContext context)
void	CompositeProtocolSupport.setExpandsConfigMetadata(Transport transport, ExpandsConfigMetadataSupplier supplier)

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

返回Transport的org.jetlinks.core.device中的方法

限定符和类型	方法和说明
Transport	AuthenticationRequest.getTransport()

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

实现Transport的org.jetlinks.core.message.codec中的类

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

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

限定符和类型	方法和说明
Transport	DeviceMessageCodec.getSupportTransport()
Transport	TransportDeviceMessageCodec.getSupportTransport()
Transport	InterceptorDeviceMessageCodec.getSupportTransport()
static Transport	Transport.of(String id) 使用指定的ID来创建协议定义

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

限定符和类型	方法和说明
static List<Transport>	Transports.get()
static List<Transport>	Transport.getAll()
static Optional<Transport>	Transports.lookup(String id)
static Optional<Transport>	Transport.lookup(String id) 通过ID查找协议定义,可通过Transports.register(Transport)来注册自定义的协议

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

限定符和类型	方法和说明
default boolean	Transport.isSame(Transport transport) 比较与指定等协议是否为同一种协议
static reactor.core.Disposable	Transports.register(Transport transport)

类型变量类型为Transport的org.jetlinks.core.message.codec中的方法参数

限定符和类型	方法和说明
static reactor.core.Disposable	Transports.register(Collection<Transport> transport)

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

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

限定符和类型	方法和说明
Transport	ChildrenDeviceSession.getTransport()
Transport	KeepOnlineSession.getTransport()
Transport	DeviceSession.getTransport() 传输协议,比如MQTT,TCP等

参数类型为Transport的org.jetlinks.core.server.session中的方法

限定符和类型	方法和说明
long	DeviceSessionManager.getCurrentSession(Transport transport) 已过时。
long	DeviceSessionManager.getMaximumSession(Transport transport) 已过时。
boolean	DeviceSessionManager.isOutOfMaximumSessionLimit(Transport transport) 已过时。