socket.lua 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. --- 模块功能:数据链路激活、SOCKET管理(创建、连接、数据收发、状态维护)
  2. -- @module socket
  3. -- @author openLuat
  4. -- @license MIT
  5. -- @copyright openLuat
  6. -- @release 2017.9.25
  7. require "socket4G"
  8. module(..., package.seeall)
  9. socket.isReady = link.isReady
  10. local tSocketModule = nil
  11. local function init()
  12. tSocketModule = tSocketModule or {
  13. [link.CELLULAR] = socket4G,
  14. [link.CH395] = socketCh395,
  15. [link.W5500] = socketW5500
  16. }
  17. end
  18. --- 创建基于TCP的socket对象
  19. -- @bool[opt=nil] ssl,是否为ssl连接,true表示是,其余表示否
  20. -- @table[opt=nil] cert,ssl连接需要的证书配置,只有ssl参数为true时,此参数才有意义,cert格式如下:
  21. -- {
  22. -- caCert = "ca.crt", --CA证书文件(Base64编码 X.509格式),如果存在此参数,则表示客户端会对服务器的证书进行校验;不存在则不校验
  23. -- clientCert = "client.crt", --客户端证书文件(Base64编码 X.509格式),服务器对客户端的证书进行校验时会用到此参数
  24. -- clientKey = "client.key", --客户端私钥文件(Base64编码 X.509格式)
  25. -- clientPassword = "123456", --客户端证书文件密码[可选]
  26. -- }
  27. -- @table[opt=nil] tCoreExtPara,建立链接扩展参数,4G链接和ch395链接所需扩展参数不一样
  28. -- @return client,创建成功返回socket客户端对象;创建失败返回nil
  29. -- @usage
  30. -- c = socket.tcp()
  31. -- c = socket.tcp(true)
  32. -- c = socket.tcp(true, {caCert="ca.crt"})
  33. -- c = socket.tcp(true, {caCert="ca.crt", clientCert="client.crt", clientKey="client.key"})
  34. -- c = socket.tcp(true, {caCert="ca.crt", clientCert="client.crt", clientKey="client.key", clientPassword="123456"})
  35. function tcp(ssl, cert, tCoreExtPara)
  36. init()
  37. return tSocketModule[link.getNetwork()].tcp(ssl, cert, tCoreExtPara)
  38. end
  39. --- 创建基于UDP的socket对象
  40. -- @return client,创建成功返回socket客户端对象;创建失败返回nil
  41. -- @usage c = socket.udp()
  42. function udp()
  43. init()
  44. return tSocketModule[link.getNetwork()].udp()
  45. end
  46. --- 设置TCP层自动重传的参数
  47. -- @number[opt=4] retryCnt,重传次数;取值范围0到12
  48. -- @number[opt=16] retryMaxTimeout,限制每次重传允许的最大超时时间(单位秒),取值范围1到16
  49. -- @return nil
  50. -- @usage
  51. -- setTcpResendPara(3,8)
  52. -- setTcpResendPara(4,16)
  53. function setTcpResendPara(retryCnt, retryMaxTimeout)
  54. init()
  55. return tSocketModule[link.getNetwork()].setTcpResendPara(retryCnt, retryMaxTimeout)
  56. end
  57. --- 设置域名解析参数
  58. -- 注意:0027以及之后的core版本才支持此功能
  59. -- @number[opt=4] retryCnt,重传次数;取值范围1到8
  60. -- @number[opt=4] retryTimeoutMulti,重传超时时间倍数,取值范围1到5
  61. -- 第n次重传超时时间的计算方式为:第n次的重传超时基数*retryTimeoutMulti,单位为秒
  62. -- 重传超时基数表为{1, 1, 2, 4, 4, 4, 4, 4}
  63. -- 第1次重传超时时间为:1*retryTimeoutMulti 秒
  64. -- 第2次重传超时时间为:1*retryTimeoutMulti 秒
  65. -- 第3次重传超时时间为:2*retryTimeoutMulti 秒
  66. -- ...........................................
  67. -- 第8次重传超时时间为:8*retryTimeoutMulti 秒
  68. -- @return nil
  69. -- @usage
  70. -- socket.setDnsParsePara(8,5)
  71. function setDnsParsePara(retryCnt, retryTimeoutMulti)
  72. init()
  73. return tSocketModule[link.getNetwork()].setDnsParsePara(retryCnt, retryTimeoutMulti)
  74. end
  75. --- 打印所有socket的状态
  76. -- @return 无
  77. -- @usage socket.printStatus()
  78. function printStatus()
  79. init()
  80. return tSocketModule[link.getNetwork()].printStatus()
  81. end
  82. --- 设置数据传输后,允许进入休眠状态的延时时长
  83. -- 3024版本以及之后的版本才支持此功能
  84. -- 此功能设置的参数,设置成功后,掉电会自动保存
  85. -- @number tm,数据传输后,允许进入休眠状态的延时时长,单位为秒,取值范围1到20
  86. -- 注意:此时间越短,允许进入休眠状态越快,功耗越低;但是在某些网络环境中,此时间越短,可能会造成数据传输不稳定
  87. -- 建议在可以接受的功耗范围内,此值设置的越大越好
  88. -- 如果没有设置此参数,此延时时长是和基站的配置有关,一般来说是10秒左右
  89. -- @return nil
  90. -- @usage
  91. -- socket.setLowPower(5)
  92. function setLowPower(tm)
  93. init()
  94. return tSocketModule[link.getNetwork()].setLowPower(tm)
  95. end