pingModule

来自于:开发者

ping pingTest

概述

pingModule1.0.0版本目前封装了ping的测试能力,使用此模块可轻松实现单个ping功能和ping测试功能。

ping

获取ping某一个IP或者域名的结果,可以通过该方法判断是否可以和服务器交互.

ping({params}, callback(ret, err))

params

target:

  • 类型:字符串
  • 默认值:无
  • 描述:目标主机IP或者域名,不能为空

callback(ret, err)

ret:

  • 类型:JSON 对象

内部字段:

  1. {
  2. status: //操作成功状态值 true表示可以ping通,false表示无法ping通。
  3. }

err:

  • 类型:JSON 对象

内部字段:

  1. {
  2. code: //错误代码 参考错误代码
  3. msg:"" //错误描述
  4. }

示例代码

  1. var pingModule = api.require('pingModule');
  2. var targethost = "www.baidu.com";
  3. pingModule.ping({
  4. target: targethost
  5. },
  6. function(ret, err) {
  7. if (ret) {
  8. api.alert({ msg: JSON.stringify(ret) });
  9. return;
  10. }
  11. if (err) {
  12. api.alert({ msg: err.msg });
  13. }
  14. }
  15. );

补充说明

可用性

Android系统

可提供的1.0.0及更高版本

pingTest

执行ping测试,默认执行5次ping测试,并返回每一个的执行结果

pingTest({params}, callback(ret, err))

params

target:

  • 类型:字符串
  • 默认值:无
  • 描述:目标主机IP或者域名,不能为空

size:

  • 类型:字符串
  • 默认值:64
  • 描述:ping测试的字节数,默认为64B

time:

  • 类型:整型
  • 默认值:5
  • 描述:ping测试的次数,默认为5次

timeout:

  • 类型:整型
  • 默认值:5
  • 描述:ping测试的超时时间,默认为5毫秒

callback(ret, err)

ret:

  • 类型:JSON 对象

内部字段:

  1. {
  2. status:true //操作成功状态值 布尔类型
  3. time: //返回每次ping测试的延时结果 单位为ms
  4. sumtime //返回ping测试的总延时结果 单位为ms
  5. avgtime //返回ping测试的平均延时结果 单位为ms
  6. successtimes //ping命令执行成功次数
  7. failtimes: //ping命令执行失败次数
  8. pingloss: //ping命令执行丢失包百分比 数值为 failtime/(successtimes + failtimes)
  9. ttl: //TTL是IPv4包头的一个8 bit字段
  10. }

err:

  • 类型:JSON 对象

内部字段:

  1. {
  2. code: //错误代码 参考错误代码
  3. msg:"" //错误描述
  4. }

示例代码

  1. var pingModule = api.require('pingModule');
  2. var targethost = "www.baidu.com";
  3. var size = 64;
  4. var time = 5;
  5. var timeout = 5;
  6. pingModule.pingTest({
  7. target: targethost,
  8. size: size,
  9. time: time,
  10. timeout: timeout
  11. },
  12. function(ret, err) {
  13. if (ret) {
  14. if (err) {
  15. api.alert({ msg: "ret " + JSON.stringify(ret) + "err " + JSON.stringify(err) });
  16. return;
  17. }
  18. api.alert({ msg: JSON.stringify(ret) });
  19. return;
  20. }
  21. if (err) {
  22. api.alert({ msg: err.msg });
  23. }
  24. }
  25. );

补充说明

可用性

Android系统

可提供的1.0.0及更高版本

错误码

错误码

取值范围:

  • 1 //请求超时
  • 2 //未知主机地址
  • 3 //错误:连接失败
  • 4 //连接中断
  • 5 //无法读出数据
  • 6 //JS传递的主机参数为空
  • 99 //其他错误 参考msg