HARIX RCU v1.2.0
network.h 文件参考

机器人网络模块,主要用于监听获取VBN的相关状态。 更多...

类型定义

typedef void(* VpnConnectStatusCallBack) (void *context, VpnConnectState status)
 Vpn连接状态函数指针 更多...
 
typedef void(* VpnQualityInfoCallBack) (void *context, const char *quality)
 Vpn质量信息函数指针 更多...
 
typedef void(* VpnQualityStatusCallBack) (void *context, VpnQualityState status)
 Vpn网络状态(弱网状态)函数指针 更多...
 

枚举

enum  VpnConnectState { KConnectFail = 0 , KConnectSuccess }
 VBN的连接状态 更多...
 
enum  VpnQualityState { KGreen = 1 , KYellow , KRed }
 Vpn的网络质量状态,绿灯(网络正常),黄灯(弱网),红灯(断网) 更多...
 

函数

void HarixRcu_Network_SubscribeVpnConnectStatusCallback (void *context, VpnConnectStatusCallBack vpnConnectStatusCallback)
 注册监听Vpn连接状态回调接口 更多...
 
void HarixRcu_Network_UnsubscribeVpnConnectStatusCallback ()
 取消注册监听Vpn连接状态回调接口 更多...
 
void HarixRcu_Network_SubscribeVpnQualityInfoCallback (void *context, VpnQualityInfoCallBack qualityCallback)
 注册监听Vpn网络质量接口 更多...
 
void HarixRcu_Network_UnsubscribeVpnQualityInfoCallback ()
 取消注册监听Vpn网络质量回调接口 更多...
 
void HarixRcu_Network_SubscribeVpnQualityStatusCallback (void *context, VpnQualityStatusCallBack callback)
 注册监听Vpn网络状态(弱网状态)接口,需要配置弱网策略, 更多...
 
void HarixRcu_Network_UnsubscribeVpnQualityStatusCallback ()
 取消注册监听Vpn网络状态回调接口 更多...
 

详细描述

机器人网络模块,主要用于监听获取VBN的相关状态。

VBN专网,是达闼机器人运行的专属安全网络,一般情况下,在完成账号登录之后,内部会建立专属VPN的网络通道。
后续的所有通信,都是基于该VPN通道,开发人员可以通过订阅VPN的连接状态,VPN的网络质量状态,VPN的弱网状态等监控VPN的情况。

类型定义说明

◆ VpnConnectStatusCallBack

typedef void(* VpnConnectStatusCallBack) (void *context, VpnConnectState status)

Vpn连接状态函数指针

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
statusVpn连接状态值,0表示未连接,1表示已连接

◆ VpnQualityInfoCallBack

typedef void(* VpnQualityInfoCallBack) (void *context, const char *quality)

Vpn质量信息函数指针

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
qualityVpn质量信息,包含丢包率,延时,抖动等

◆ VpnQualityStatusCallBack

typedef void(* VpnQualityStatusCallBack) (void *context, VpnQualityState status)

Vpn网络状态(弱网状态)函数指针

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
statusVpn弱网状态,1表示GREEN,2表示YELLOW,3表示RED

枚举类型说明

◆ VpnConnectState

VBN的连接状态

枚举值
KConnectFail 

VBN 连接失败

KConnectSuccess 

VBN连接成功

◆ VpnQualityState

Vpn的网络质量状态,绿灯(网络正常),黄灯(弱网),红灯(断网)

枚举值
KGreen 

网络正常

KYellow 

弱网

KRed 

断网

函数说明

◆ HarixRcu_Network_SubscribeVpnConnectStatusCallback()

void HarixRcu_Network_SubscribeVpnConnectStatusCallback ( void *  context,
VpnConnectStatusCallBack  vpnConnectStatusCallback 
)

注册监听Vpn连接状态回调接口

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
vpnConnectStatusCallbackVpn连接状态回调

◆ HarixRcu_Network_UnsubscribeVpnConnectStatusCallback()

void HarixRcu_Network_UnsubscribeVpnConnectStatusCallback ( )

取消注册监听Vpn连接状态回调接口

◆ HarixRcu_Network_SubscribeVpnQualityInfoCallback()

void HarixRcu_Network_SubscribeVpnQualityInfoCallback ( void *  context,
VpnQualityInfoCallBack  qualityCallback 
)

注册监听Vpn网络质量接口

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
qualityCallbackVpn网络质量回调

◆ HarixRcu_Network_UnsubscribeVpnQualityInfoCallback()

void HarixRcu_Network_UnsubscribeVpnQualityInfoCallback ( )

取消注册监听Vpn网络质量回调接口

◆ HarixRcu_Network_SubscribeVpnQualityStatusCallback()

void HarixRcu_Network_SubscribeVpnQualityStatusCallback ( void *  context,
VpnQualityStatusCallBack  callback 
)

注册监听Vpn网络状态(弱网状态)接口,需要配置弱网策略,

参数
context上下文对象实例,用于调用者在回调函数中访问自己的对象
callbackVpn网络状态(弱网状态)回调

◆ HarixRcu_Network_UnsubscribeVpnQualityStatusCallback()

void HarixRcu_Network_UnsubscribeVpnQualityStatusCallback ( )

取消注册监听Vpn网络状态回调接口