Class Info |
|---|
public abstract class DiscoveryEngine 广播、扫描、连接的总体入口类,此类中实现相关的广播、扫描、连接方法。 |
Qualifier and Type | Method Name and Description |
|---|---|
abstract Task<Void> | acceptConnect(String endpointId, DataCallback dataCallback) 接收远端的连接。 |
abstract void | disconnect(String endpointId) 连接建立成功后,调用此方法可以断开与远端的连接。 |
abstract void | 断开所有已经建立的连接,并删除所有连接信息。 |
abstract Task<Void> | rejectConnect(String endpointId) 拒绝一个对端连接请求。 |
abstract Task<Void> | requestConnect(String name, String endpointId, ConnectCallback connectCallback) 发送一个连接请求到远端。 |
abstract Task<Void> | requestConnectEx(String name, String endpointId, ConnectCallback connectCallback, ConnectOption option) requestConnect(String, String, ConnectCallback)的扩展接口,发送一个连接请求到远端,可携带特定连接选项。 |
abstract Task<Void> | startBroadcasting(String name, String serviceId, ConnectCallback connectCallback, BroadcastOption option) 启动广播,开始广播本端应用或者服务消息。 |
abstract Task<Void> | startScan(String serviceId, ScanEndpointCallback scanEndpointCallback, ScanOption option) 启动发现指定serviceId的远端设备。 |
abstract void | 不需要广播服务时,停止广播。建议在建立连接后,调用此方法,以获得后续传输业务更好的性能。 |
abstract void | stopScan() 不需要发现更多远端设备时,停止发现。推荐在建立连接后,调用此方法,减少同频干扰,以获得后续传输业务更好的性能。 |
Method |
|---|
public abstract Task<Void> acceptConnect(String endpointId, DataCallback dataCallback) 接受远端的连接。连接的两端都调用此接口,才能建立连接。调用requestConnectEx(String, String, ConnectCallback,ConnectOption)发起建连8秒内,如果未调用此接口接受连接则连接失败,需要重新发起建连。API执行返回的主要状态码包括:
|
Parameters
Name | Description |
|---|---|
endpointId | 远端设备的endpointId。此值应与onEstablish(String, String, ConnectCallback)中的值保持一致。 |
dataCallback | 与远端进行数据传输回调,用于数据接收或者收发进度通知。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |
Method |
|---|
public abstract void disconnect(String endpointId) 断开与远端的连接。一旦调用此接口,将不能在此端点上收发数据。 |
Parameters
Name | Description |
|---|---|
endpointId | 远端设备的endpointId。 |
Method |
|---|
public abstract Task<Void> rejectConnect(String endpointId) 拒绝一个对端连接请求。连接的两端,任一端调用rejectConnect(String)接口,连接都无法建立。API执行返回的主要状态码包括:
|
Parameters
Name | Description |
|---|---|
endpointId | 远端设备的endpointId。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |
Method |
|---|
public abstract Task<Void> requestConnect(String name, String endpointId, ConnectCallback connectCallback) 发送一个连接请求到远端。API执行返回的主要状态码包括:
注意: 该接口已在版本5.2.0.301废弃,替换接口为requestConnectEx(String, String, ConnectCallback, ConnectOption)。为了保证旧版本功能正常,在当前版本依然可以使用。 |
Parameters
Name | Description |
|---|---|
name | 本地设备名称。此名称主要是便于对端辨识本端设备,可读性强,辨识度高。比如可以使用设备的型号。 |
endpointId | 远端设备的endpointId。 |
connectCallback | 连接事件的监听回调。需要用户复写ConnectCallback抽象类方法。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |
Method |
|---|
public abstract Task<Void> requestConnectEx(String name, String endpointId, ConnectCallback connectCallback, ConnectOption option) requestConnect(String, String, ConnectCallback)的扩展接口,发送一个连接请求到远端,可携带特定连接选项。API执行返回的主要状态码包括:
|
Parameters
Name | Description |
|---|---|
name | 本地设备名称。此名称主要是便于对端辨识本端设备,可读性强,辨识度高。比如可以使用设备的型号。 |
endpointId | 远端设备的endpointId。 |
connectCallback | 连接事件的监听回调。需要用户复写ConnectCallback抽象类方法。 |
option | 连接选项,可通过ConnectOption.Builder构造,并根据业务特征设置具体ChannelPolicy。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |
Method |
|---|
public abstract Task<Void> startBroadcasting(String name, String serviceId, ConnectCallback connectCallback, BroadcastOption option) 启动广播,开始广播本端应用或者服务消息。API执行返回的主要状态码包括:
|
Parameters
Name | Description |
|---|---|
name | 本地设备名称。此名称主要是便于对端辨识本端设备,可读性强,辨识度高。比如可以使用设备的型号。 |
serviceId | 服务ID,用于标识自己的服务,推荐使用应用包名。 |
connectCallback | 连接监听回调,用于监听对端连接请求事件。 |
option | 广播选项。通过BroadcastOption.Builder构造类构造option,并设置Policy。广播选项的策略应与扫描选项的策略保持一致,否则无法被发现。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |
Method |
|---|
public abstract Task<Void> startScan(String serviceId, ScanEndpointCallback scanEndpointCallback, ScanOption option) 启动发现指定serviceId的远端设备。API执行返回的主要状态码包括:
|
Parameters
Name | Description |
|---|---|
serviceId | 服务ID,用于标识自己的服务,推荐使用应用包名。 |
scanEndpointCallback | 发现监听回调,发现对端设备时触发回调。 |
option | 扫描选项。通过ScanOption.Builder构造类构造option,并设置连接Policy。扫描选项的策略应与广播选项的策略保持一致,否则无法被发现。 |
Returns
Type | Description |
|---|---|
Task<Void> | Task封装的API调用结果,应用可注册回调获取结果详情。 |