com.aliyun.alink.linksdk.channel.gateway.api

接口 IGatewayChannel

所有已知实现类:

GatewayChannel

public interface IGatewayChannel

设备网关接口类

方法概要

限定符和类型	方法和说明
void	addSubDevice(SubDeviceInfo deviceInfo, ISubDeviceConnectListener subDeviceConnectListener) 建立 topo 关系
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) 上报发现的子设备列表 可能用于第三方应用获取并选择添加拓扑关系
ConnectState	getGatewayConnectState() 获取当前长连接通道状态
ISubDeviceChannel	getSubDeviceChannel(java.lang.String sudDeviceId) 获取子设备连接通道
void	getSubDevices(IConnectSendListener listener) 获取子设备列表
void	registerDownstreamListener(boolean uiSafey, IGatewayDownstreamListener listener) 已过时。
void	removeSubDevice(SubDeviceInfo subDeviceInfo, ISubDeviceRemoveListener removeListener) 删除 topo 关系
void	startConnect(Context context, GatewayConnectConfig config, IGatewayConnectListener listener) 长连接通道启动接口，应用起来时调用一次
void	startConnectReuseMobileChannel(Context context, IGatewayConnectListener listener) 长连接通道启动借口给，复用Mobile Channel接口
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的接口

方法详细资料

startConnect

void startConnect(Context context,
                  GatewayConnectConfig config,
                  IGatewayConnectListener listener)

长连接通道启动接口，应用起来时调用一次

参数:

context -

config - 通道建联配置项

listener - 反馈通道状态变化

startConnectReuseMobileChannel

void startConnectReuseMobileChannel(Context context,
                                    IGatewayConnectListener listener)

长连接通道启动借口给，复用Mobile Channel接口

参数:

context -

listener - 反馈通道状态变化

getGatewayConnectState

ConnectState getGatewayConnectState()

获取当前长连接通道状态

返回:

当前连接专题该你

subDeviceRegister

void subDeviceRegister(java.util.List<SubDeviceInfo> infoList,
                       IConnectSendListener listener)

subDevicUnregister

void subDevicUnregister(java.util.List<SubDeviceInfo> infoList,
                        IConnectSendListener listener)

addSubDevice

void addSubDevice(SubDeviceInfo deviceInfo,
                  ISubDeviceConnectListener subDeviceConnectListener)

建立 topo 关系

参数:

deviceInfo - 子设备信息

subDeviceConnectListener - 子设备上下行数据通道

removeSubDevice

void removeSubDevice(SubDeviceInfo subDeviceInfo,
                     ISubDeviceRemoveListener removeListener)

删除 topo 关系

参数:

subDeviceInfo - 子设备信息

getSubDevices

void getSubDevices(IConnectSendListener listener)

获取子设备列表

参数:

listener - 监听器

deviceListUpload

void deviceListUpload(java.util.List<SubDeviceInfo> foundList,
                      IConnectSendListener listener)

上报发现的子设备列表 可能用于第三方应用获取并选择添加拓扑关系

参数:

foundList - 子设备列表

listener - 监听器

asyncSendRequest

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。

参数:

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

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。这个接口不会有业务回执。

参数:

topic - rpc请求的topic，由具体业务确定，上行的完整topic形如： /sys/${productKey}/${deviceName}/app/up/abc/cba 其中App 端 Topic 订阅协议前缀：/sys/${productKey}/${deviceName}/app/up 在sdk中会自动补齐。 所以开发者只需要传完整topic的业务部分，如上例中的/abc/cba即可。 也可以使用通配符 如/abc/#.

params -

listener -

subscribe

void subscribe(java.lang.String topic,
               IGatewaySubscribeListener listener)

app订阅topic的接口

参数:

topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见invokeWithTopic:opts:params:respHandler: 中的topic定义

listener - 订阅流程结束的监听

unSubscribe

void unSubscribe(java.lang.String topic,
                 IGatewaySubscribeListener listener)

app取消订阅topic的接口

参数:

topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见asyncSendRequest 中的topic定义

listener - 订阅流程结束的监听

registerDownstreamListener

@Deprecated
void registerDownstreamListener(boolean uiSafey,
                                             IGatewayDownstreamListener listener)

已过时。

设置通道的下推回调，如果不需要用的时候，unRegisterDownstreamListener

参数:

uiSafey - 是否要在UI线程里回调，建议为YES

listener -

unRegisterDownstreamListener

@Deprecated
void unRegisterDownstreamListener(IGatewayDownstreamListener listener)

已过时。

取消某个通道的下推回调

参数:

listener -

getSubDeviceChannel

ISubDeviceChannel getSubDeviceChannel(java.lang.String sudDeviceId)

获取子设备连接通道

参数:

sudDeviceId - 子设备ID pk+dn

返回:

子设备连接通道

destroyConnect

void destroyConnect()

断开长链接通道