GatewayChannel

java.lang.Object
- com.aliyun.alink.linksdk.channel.gateway.api.GatewayChannel

All Implemented Interfaces:: IGatewayChannel

public class GatewayChannel
extends java.lang.Object
implements IGatewayChannel

设备网关入口类

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DID_SEPARATOR`
`static java.lang.String`	`METHOD_PRESET_SUBDEV_REGITER`
`static java.lang.String`	`TOPIC_PRESET_SUBDEV_REGITER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSubDevice(SubDeviceInfo deviceInfo, ISubDeviceConnectListener subDeviceConnectListener)` 建立 topo 关系
`void`	`addSubDeviceForILopGlobal(SubDeviceInfo deviceInfo, ISubDeviceConnectListener subDeviceConnectListener)` 注意：该接口只支持在飞燕（生活物联网平台）使用，不支持 LP（阿里云物联网平台）使用，LP平台请使用 `IGatewayChannel.addSubDevice(SubDeviceInfo, ISubDeviceConnectListener)` 接口 iLop 飞燕全球版本添加拓扑关系接口，该接口和 `IGatewayChannel.addSubDevice(SubDeviceInfo, ISubDeviceConnectListener)` 功能类似且互斥，不支持两个接口混用该接口不需要子设备的deviceSecret做sign值计算，所以也不需要再使用上面的子设备动态注册 `IGatewayChannel.subDeviceRegister(List, IConnectSendListener)`的接口了
`void`	`asyncSendRequest(java.lang.String topic, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> opts, java.lang.Object params, IGatewayRequestListener listener)` RPC请求接口，封装了业务的上行request以及下行resp。
`void`	`ayncSendPublishRequest(java.lang.String topic, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> opts, java.lang.Object params, IGatewayRequestListener listener)` 发布消息接口，不同于asyncSendRequest。这个接口不会有业务回执。
`void`	`destroyConnect()` 断开长链接通道
`void`	`deviceListUpload(java.util.List<SubDeviceInfo> foundList, IConnectSendListener listener)` 上报发现的子设备列表可能用于第三方应用获取并选择添加拓扑关系
`GatewayConnectState`	`getGatewayConnectState()` 获取当前长连接通道状态
`static IGatewayChannel`	`getInstance()`
`PersistentConnectConfig`	`getPersistentConnectConfig()`
`ISubDeviceChannel`	`getSubDeviceChannel(java.lang.String sudDeviceId)` 获取子设备连接通道
`void`	`getSubDevices(IConnectSendListener listener)` 获取子设备列表
`void`	`registerDownstreamListener(boolean uiSafey, IGatewayDownstreamListener listener)` 设置通道的下推回调，如果不需要用的时候，unRegisterDownstreamListener
`void`	`removeSubDevice(SubDeviceInfo subDeviceInfo, ISubDeviceRemoveListener removeListener)` 删除 topo 关系
`void`	`setNeedAutoLoginSubdevice(boolean needAutoLoginSubdevice)`
`void`	`startConnect(Context context, PersistentConnectConfig config, IGatewayConnectListener listener)` 长连接通道启动接口，应用起来时调用一次
`void`	`startConnectReuseMobileChannel(Context context, IGatewayConnectListener listener)` 长连接通道启动借口给，复用Mobile Channel接口
`void`	`subDeviceRegister(ARequest requestData, IConnectSendListener listener)` 子设备动态注册通用接口，上报数据由用户封装，topic如果为空则默认使用 /sys/pk/dn/thing/proxy/provisioning/product_register 当前version 使用 1.0
`void`	`subDeviceRegister(java.util.List<SubDeviceInfo> infoList, IConnectSendListener listener)` 子设备动态注册
`void`	`subDevicUnregister(java.util.List<SubDeviceInfo> infoList, IConnectSendListener listener)` 取消子设备动态注册
`void`	`subscribe(java.lang.String topic, IGatewaySubscribeListener listener)` app订阅topic的接口
`void`	`unRegisterDownstreamListener(IGatewayDownstreamListener listener)` 取消某个通道的下推回调
`void`	`unSubscribe(java.lang.String topic, IGatewaySubscribeListener listener)` app取消订阅topic的接口

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DID_SEPARATOR
```
public static final java.lang.String DID_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - TOPIC_PRESET_SUBDEV_REGITER
```
public static final java.lang.String TOPIC_PRESET_SUBDEV_REGITER
```
    See Also:
    
    Constant Field Values
  - METHOD_PRESET_SUBDEV_REGITER
```
public static final java.lang.String METHOD_PRESET_SUBDEV_REGITER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setNeedAutoLoginSubdevice
```
public void setNeedAutoLoginSubdevice(boolean needAutoLoginSubdevice)
```
  - getInstance
```
public static IGatewayChannel getInstance()
```
  - startConnect
```
public void startConnect(Context context,
                         PersistentConnectConfig config,
                         IGatewayConnectListener listener)
```
    Description copied from interface: IGatewayChannel
    
    长连接通道启动接口，应用起来时调用一次
    
    Specified by:
    
    startConnect in interface IGatewayChannel
    
    config - 通道建联配置项
    
    listener - 反馈通道状态变化
  - startConnectReuseMobileChannel
```
public void startConnectReuseMobileChannel(Context context,
                                           IGatewayConnectListener listener)
```
    Description copied from interface: IGatewayChannel
    
    长连接通道启动借口给，复用Mobile Channel接口
    
    Specified by:
    
    startConnectReuseMobileChannel in interface IGatewayChannel
    
    listener - 反馈通道状态变化
  - getGatewayConnectState
```
public GatewayConnectState getGatewayConnectState()
```
    Description copied from interface: IGatewayChannel
    
    获取当前长连接通道状态
    
    Specified by:
    
    getGatewayConnectState in interface IGatewayChannel
    
    Returns:
    
    当前连接专题该你
  - subDeviceRegister
```
public void subDeviceRegister(java.util.List<SubDeviceInfo> infoList,
                              IConnectSendListener listener)
```
    Description copied from interface: IGatewayChannel
    
    子设备动态注册
    
    Specified by:
    
    subDeviceRegister in interface IGatewayChannel
    
    Parameters:
    
    infoList - 子设备列表
    
    listener - 监听器
  - subDeviceRegister
```
public void subDeviceRegister(ARequest requestData,
                              IConnectSendListener listener)
```
    Description copied from interface: IGatewayChannel
    
    子设备动态注册通用接口，上报数据由用户封装，topic如果为空则默认使用 /sys/pk/dn/thing/proxy/provisioning/product_register 当前version 使用 1.0
    
    Specified by:
    
    subDeviceRegister in interface IGatewayChannel
    
    Parameters:
    
    requestData - 需要动态注册的列表数据
    
    listener - 监听器
  - subDevicUnregister
```
public void subDevicUnregister(java.util.List<SubDeviceInfo> infoList,
                               IConnectSendListener listener)
```
    Description copied from interface: IGatewayChannel
    
    取消子设备动态注册
    
    Specified by:
    
    subDevicUnregister in interface IGatewayChannel
    
    Parameters:
    
    infoList - 子设备列表
    
    listener - 监听器
  - addSubDevice
```
public void addSubDevice(SubDeviceInfo deviceInfo,
                         ISubDeviceConnectListener subDeviceConnectListener)
```
    Description copied from interface: IGatewayChannel
    
    建立 topo 关系
    
    Specified by:
    
    addSubDevice in interface IGatewayChannel
    
    Parameters:
    
    deviceInfo - 子设备信息
    
    subDeviceConnectListener - 子设备上下行数据通道
  - addSubDeviceForILopGlobal
```
public void addSubDeviceForILopGlobal(SubDeviceInfo deviceInfo,
                                      ISubDeviceConnectListener subDeviceConnectListener)
```
    Description copied from interface: IGatewayChannel
    
    注意：该接口只支持在飞燕（生活物联网平台）使用，不支持 LP（阿里云物联网平台）使用，LP平台请使用 IGatewayChannel.addSubDevice(SubDeviceInfo, ISubDeviceConnectListener) 接口 iLop 飞燕全球版本添加拓扑关系接口，该接口和 IGatewayChannel.addSubDevice(SubDeviceInfo, ISubDeviceConnectListener) 功能类似且互斥，不支持两个接口混用该接口不需要子设备的deviceSecret做sign值计算，所以也不需要再使用上面的子设备动态注册 IGatewayChannel.subDeviceRegister(List, IConnectSendListener)的接口了
    
    Specified by:
    
    addSubDeviceForILopGlobal in interface IGatewayChannel
    
    Parameters:
    
    deviceInfo - 子设备信息
    
    subDeviceConnectListener - 监听器
  - removeSubDevice
```
public void removeSubDevice(SubDeviceInfo subDeviceInfo,
                            ISubDeviceRemoveListener removeListener)
```
    Description copied from interface: IGatewayChannel
    
    删除 topo 关系
    
    Specified by:
    
    removeSubDevice in interface IGatewayChannel
    
    Parameters:
    
    subDeviceInfo - 子设备信息
  - getSubDevices
```
public void getSubDevices(IConnectSendListener listener)
```
    Description copied from interface: IGatewayChannel
    
    获取子设备列表
    
    Specified by:
    
    getSubDevices in interface IGatewayChannel
    
    Parameters:
    
    listener - 监听器
  - deviceListUpload
```
public void deviceListUpload(java.util.List<SubDeviceInfo> foundList,
                             IConnectSendListener listener)
```
    Description copied from interface: IGatewayChannel
    
    上报发现的子设备列表可能用于第三方应用获取并选择添加拓扑关系
    
    Specified by:
    
    deviceListUpload in interface IGatewayChannel
    
    Parameters:
    
    foundList - 子设备列表
    
    listener - 监听器
  - asyncSendRequest
```
public void asyncSendRequest(java.lang.String topic,
                             java.lang.String method,
                             java.util.Map<java.lang.String,java.lang.Object> opts,
                             java.lang.Object params,
                             IGatewayRequestListener listener)
```
    Description copied from interface: IGatewayChannel
    
    RPC请求接口，封装了业务的上行request以及下行resp。
    
    Specified by:
    
    asyncSendRequest in interface IGatewayChannel
    
    Parameters:
    
    topic - topic rpc请求的topic，由具体业务确定，完整topic形如： /sys/${productKey}/${deviceName}/app/abc/cba 其中App 端 Topic 订阅协议前缀：/sys/${productKey}/${deviceName}/app/ 所以开发者只需要传完整topic的业务部分，如上例中的abc/cba即可。也可以使用通配符如abc/#.
    
    method - payload 中的method
    
    opts - 可选配置项，可空，预留
    
    params - 业务参数。
    
    listener - 业务服务器响应回调接口
  - ayncSendPublishRequest
```
public void ayncSendPublishRequest(java.lang.String topic,
                                   java.lang.String method,
                                   java.util.Map<java.lang.String,java.lang.Object> opts,
                                   java.lang.Object params,
                                   IGatewayRequestListener listener)
```
    Description copied from interface: IGatewayChannel
    
    发布消息接口，不同于asyncSendRequest。这个接口不会有业务回执。
    
    Specified by:
    
    ayncSendPublishRequest in interface IGatewayChannel
    
    Parameters:
    
    topic - rpc请求的topic，由具体业务确定，上行的完整topic形如： /sys/${productKey}/${deviceName}/app/up/abc/cba 其中App 端 Topic 订阅协议前缀：/sys/${productKey}/${deviceName}/app/up 在sdk中会自动补齐。所以开发者只需要传完整topic的业务部分，如上例中的/abc/cba即可。也可以使用通配符如/abc/#.
  - subscribe
```
public void subscribe(java.lang.String topic,
                      IGatewaySubscribeListener listener)
```
    Description copied from interface: IGatewayChannel
    
    app订阅topic的接口
    
    Specified by:
    
    subscribe in interface IGatewayChannel
    
    Parameters:
    
    topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见invokeWithTopic:opts:params:respHandler: 中的topic定义
    
    listener - 订阅流程结束的监听
  - unSubscribe
```
public void unSubscribe(java.lang.String topic,
                        IGatewaySubscribeListener listener)
```
    Description copied from interface: IGatewayChannel
    
    app取消订阅topic的接口
    
    Specified by:
    
    unSubscribe in interface IGatewayChannel
    
    Parameters:
    
    topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见asyncSendRequest 中的topic定义
    
    listener - 订阅流程结束的监听
  - registerDownstreamListener
```
public void registerDownstreamListener(boolean uiSafey,
                                       IGatewayDownstreamListener listener)
```
    Description copied from interface: IGatewayChannel
    
    设置通道的下推回调，如果不需要用的时候，unRegisterDownstreamListener
    
    Specified by:
    
    registerDownstreamListener in interface IGatewayChannel
    
    Parameters:
    
    uiSafey - 是否要在UI线程里回调，建议为YES
  - unRegisterDownstreamListener
```
public void unRegisterDownstreamListener(IGatewayDownstreamListener listener)
```
    Description copied from interface: IGatewayChannel
    
    取消某个通道的下推回调
    
    Specified by:
    
    unRegisterDownstreamListener in interface IGatewayChannel
  - getSubDeviceChannel
```
public ISubDeviceChannel getSubDeviceChannel(java.lang.String sudDeviceId)
```
    Description copied from interface: IGatewayChannel
    
    获取子设备连接通道
    
    Specified by:
    
    getSubDeviceChannel in interface IGatewayChannel
    
    Parameters:
    
    sudDeviceId - 子设备ID pk+dn
    
    Returns:
    
    子设备连接通道
  - destroyConnect
```
public void destroyConnect()
```
    Description copied from interface: IGatewayChannel
    
    断开长链接通道
    
    Specified by:
    
    destroyConnect in interface IGatewayChannel
  - getPersistentConnectConfig
```
public PersistentConnectConfig getPersistentConnectConfig()
```
    Specified by:
    
    getPersistentConnectConfig in interface IGatewayChannel
    
    Returns:
    
    PersistentConnectConfig

Class GatewayChannel

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DID_SEPARATOR

TOPIC_PRESET_SUBDEV_REGITER

METHOD_PRESET_SUBDEV_REGITER

Method Detail

setNeedAutoLoginSubdevice

getInstance

startConnect

startConnectReuseMobileChannel

getGatewayConnectState

subDeviceRegister

subDeviceRegister

subDevicUnregister

addSubDevice

addSubDeviceForILopGlobal

removeSubDevice

getSubDevices

deviceListUpload

asyncSendRequest

ayncSendPublishRequest

subscribe

unSubscribe

registerDownstreamListener

unRegisterDownstreamListener

getSubDeviceChannel

destroyConnect

getPersistentConnectConfig