Skip to content

Commit

Permalink
update: 优化mqtt库的API注释
Browse files Browse the repository at this point in the history
  • Loading branch information
wendal committed Jun 9, 2023
1 parent 7366d0e commit d3a3ccd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions components/network/libemqtt/luat_lib_mqtt.c
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ int l_luat_mqtt_msg_cb(luat_mqtt_ctrl_t * ptr, int arg1, int arg2) {
@api mqttc:subscribe(topic, qos)
@string/table 主题
@int topic为string时生效 0/1/2 默认0
@return int 消息id,当qos为1时有效, 若底层返回失败,会返回nil
@return int 消息id,当qos为1/2时有效, 若底层返回失败,会返回nil
@usage
-- 订阅单个topic, 且qos=0
mqttc:subscribe("/luatos/123456", 0)
Expand Down Expand Up @@ -248,7 +248,7 @@ mqtt客户端创建
@int 适配器序号, 只能是socket.ETH0, socket.STA, socket.AP,如果不填,会选择平台自带的方式,然后是最后一个注册的适配器
@string 服务器地址,可以是域名, 也可以是ip
@int 端口号
@bool/table 是否为ssl加密连接,默认不加密,true为无证书最简单的加密,table为有证书的加密 <br>server_cert 服务器ca证书数据 <br>client_cert 客户端ca证书数据 <br>client_key 客户端私钥加密数据 <br>client_password 客户端私钥口令数据 <br>verify 是否强制校验 0不校验/1可选校验/2强制校验 默认2
@bool/table 是否为ssl加密连接,默认不加密,true为无证书最简单的加密,table为有证书的加密 <br>server_cert 服务器ca证书数据 <br>client_cert 客户端证书数据 <br>client_key 客户端私钥加密数据 <br>client_password 客户端私钥口令数据 <br>verify 是否强制校验 0不校验/1可选校验/2强制校验 默认2
@bool 是否为ipv6 默认不是
@return userdata 若成功会返回mqtt客户端实例,否则返回nil
@usage
Expand All @@ -258,6 +258,8 @@ mqttc = mqtt.create(nil,"120.55.137.106", 1884)
mqttc = mqtt.create(nil,"120.55.137.106", 8883, true)
-- 加密TCPTCP链接,单服务器证书验证
mqttc = mqtt.create(nil,"120.55.137.106", 8883, {server_cert=io.readFile("/luadb/ca.crt")})
-- 加密TCPTCP链接,单服务器证书验证, 但可选认证
mqttc = mqtt.create(nil,"120.55.137.106", 8883, {server_cert=io.readFile("/luadb/ca.crt"), verify=1})
-- 加密TCPTCP链接,双向证书验证
mqttc = mqtt.create(nil,"120.55.137.106", 8883, {
server_cert=io.readFile("/luadb/ca.crt"),
Expand Down

0 comments on commit d3a3ccd

Please sign in to comment.