帮我吧文档:客户端sdk手册:状态项列表

状态项列表

目前帮我吧客户端SDK支持如下状态项:

状态项名称 说明
SupportClientState 主控端模块的状态,取值见下文说明
UserClientState 被控端模块的状态,取值见下文说明
ConnectionStatus 到其他帮我吧客户端的连接状态,一般用于给其他客户端发送远程请求之后,用此状态来查询结果
LocalUserClientID 本地的被控端9位数ID

1. SupportClientState/UserClientState状态项取值

当使用SupportClientState或者UserClientState作为ConfName调用apiQueryConfig接口来查询这两个状态项的取值的时候,接口会返回如下格式的JSON应答:

{ 
    "errorcode" : "0", 
    "message" : "success",
    "data" : {
               "PID" : "5952", 
               "State" : "6" 
    }
} 

其中data字段中的PID代表查询的主控端模块或者被控端模块的进程ID,State为其状态,状态取值如下:

State取值 说明
0 enum_Sdk_Unknown: 初始状态
1 enum_Sdk_Init: 正在初始化
2 enum_Sdk_Running: 已成功启动
3 enum_Sdk_Uninit: 帮我吧程序正在退出
4 enum_Sdk_Login_Fail: 底层通信模块登录失败
5 enum_Sdk_VPN_Fail: 底层通信模块登录失败
6 enum_Sdk_VPN_Kickout: 底层通信模块ID号跟别人冲突

调用者在调用apiSystemInit接口之后,只有调用apiQueryConfig接口查询到SupportClientState和UserClientState是上表中状态值2的时候(即黄色背景标注的一行),才是帮我吧正常启动状态。

2. ConnectionStatus状态项取值

查询ConnectionStatus状态项时候返回的取值结果如下:

{
   "errorcode" : "0",
   "message" : "success"
   "data" : [
      {
         "111111111" : "2"
      },
      {
         "222222222" : "3"
      }
   ],
}

其中data字段内容是一个JSON数组,数组中每一项都是到某一个客户端的连接状态,111111111和222222222都是客户端的9位数ID,后面的数字表示连接状态,具体意义如下:

连接状态取值 说明
0 未连接
1 正在连接该ID
2 该ID不在线
3 成功连接到该ID
4 到该ID的链接已经关闭
5 连接该ID失败
6 程序尚未初始化完成,不能连接
7 底层通讯模块状态异常,不能连接

页面工具