Skip to content

Commit 8391edd

Browse files
committed
docs(smart-mqtt): 更新产品手册中的技术依赖描述
- 将 smart-http 替换为 Feat 作为 HTTP 服务框架- 更新 WebSocket 依赖描述 - 删除配置说明章节 - 调整附录章节编号:常见问题及调优、免责申明、关于授权
1 parent 7fa87ab commit 8391edd

File tree

1 file changed

+5
-56
lines changed

1 file changed

+5
-56
lines changed

docs/smart-mqtt/02.产品手册/01.使用说明.md

Lines changed: 5 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ smart-mqtt 底层通信采用自研的框架 [smart-socket](https://gitee.com/sm
9797
smart-mqtt 完全遵循 MQTT 协议规范,用户无需担心被本产品捆绑。任何时候若觉得这款产品不再适合自己,可快速切换至其他同类产品。
9898
- **纯国产血统**(符合信创场景需求)
9999
- 底层通信采用了自研通信框架 [smart-socket](https://gitee.com/smartboot/smart-socket)
100-
- http服务为亦是自研的 [smart-http](https://gitee.com/smartboot/smart-http)
100+
- http服务为亦是自研的 [Feat](https://smartboot.tech/feat)
101101
- 前端框架为华为云开源的前端解决方案[opentiny](https://opentiny.design/)
102102
::: tip
103103
凡是提供同类比较的技术产品,通常的结论是自身各项能力都优于其他比较对象。试问这种结果是否真的客观、公正?
@@ -272,7 +272,7 @@ smart-mqtt 企业版将提供相对自由的数据持久化选型。目前已经
272272

273273
WebSocket是一种在浏览器和web服务器之间提供双向通信的网络协议。
274274

275-
smart-mqtt 依托于 smart-http 提供的 websocket 能力,成功的将基于 websocket 协议的 MQTT 消息接入 Broker。
275+
smart-mqtt 依托于 Feat 提供的 websocket 能力,成功的将基于 websocket 协议的 MQTT 消息接入 Broker。
276276
使其与普通 TCP 形式的 MQTT 保持一致的规范、体验和服务。
277277

278278
```yaml
@@ -333,65 +333,14 @@ plugins:
333333
这种机制有助于避免单点过载,尤其是在处理大量并发消息或确保高可用性场景时。smart-mqtt 也支持共享订阅功能,允许用户在云端部署的应用程序中利用这一特性来提高系统伸缩性和消息处理效率,同时减少不必要的消息重复和潜在的数据处理瓶颈。
334334

335335
## 5. 附录
336-
### 5.1 配置说明
337-
为了提供兼具可读性和可维护性的配置体验,smart-mqtt 采用 yml 格式管理自身配置,其主体结构分为两大块:Broker基础配置、插件配置。
338-
```yaml
339-
# Broker基础配置
340-
broker:
341-
# 节点ID,集群部署时要求集群内唯一
342-
nodeId: smart-mqtt
343-
# Broker 服务的端口号,默认:1883
344-
port: 1883
345-
# Broker 服务绑定的本地 IP 地址,若为空则所有 IP 可用。
346-
host: 0.0.0.0
347-
#Broker 的服务线程数,默认等同于当前服务器的 CPU 核数。
348-
threadNum: 16
349-
#消息推送服务的线程数,默认等同于当前服务器的 CPU 核数。
350-
pushThreadNum: 16
351-
#IO缓冲区大小,默认:**4096**。合理的大小设置会带来更好的通信性能,具体参考《缓冲区调优》。
352-
bufferSize: 4096
353-
#在完成应答前,同时投递的 QoS 1 和 QoS 2 消息的最大数量。
354-
maxInflight: 256
355-
#限制单个MQTT消息包的最大字节数,默认:**1048576**(1MB)
356-
maxPacketSize: 4096
357-
#Broker支持的Topic数量上限,默认:1024.
358-
topicLimit: 1024
359-
# 客户端支持的最长`keep-alive`时长。当发送的`Connect`中夹带的keepAlive时长超过改值时,将以`maxKeepAliveTime`为准。
360-
maxKeepAliveTime:
361-
#网络连接建立后,如果服务端在合理的时间内没有收到 CONNECT 报文,服务端应该关闭这个连接。
362-
#单位:**毫秒**,默认:**5000**。
363-
noConnectIdleTimeout: 5000
364-
clusterEndpoint: mqtt://127.0.0.1:1883
365-
nodeType: "core"
366-
plugins:
367-
- enterprise:
368-
metric:
369-
enable: true
370-
period: 1
371-
openapi:
372-
port: 18083
373-
host: 0.0.0.0
374-
- database:
375-
dbType: mysql
376-
url: jdbc:mysql://{host:port}/smart_mqtt?autoReconnect=true
377-
username: username
378-
password: password
379-
- websocket:
380-
port: 1884
381-
- redis-bridge:
382-
enable: true
383-
- kafka-bridge:
384-
enable: true
385-
```
386-
387-
### 5.2 常见问题及调优
336+
### 5.1 常见问题及调优
388337

389338
为了使系统具备更大的连接能力,可在宿主机执行以下命令。
390339
```shell
391340
echo 200000000 > /proc/sys/net/netfilter/nf_conntrack_max
392341
echo 200000000 > /proc/sys/fs/file-max
393342
```
394-
### 5.3 免责申明
343+
### 5.2 免责申明
395344

396345
本免责声明适用于smart-mqtt产品(以下简称“产品”)的使用。在使用产品之前,请仔细阅读并充分理解本免责声明的内容。如您不同意本免责声明的任何内容,请立即停止使用产品。
397346

@@ -413,7 +362,7 @@ smart-mqtt是一款基于MQTT协议的开源物联网消息代理软件。它提
413362
2. 在未取得我们事先书面同意的情况下,我们不对本免责声明的任何条款进行修改或补充。
414363
3. 如果您对本免责声明有任何疑问或需要进一步解释,请联系我们。我们将尽力为您提供帮助和解答。
415364

416-
### 5.4 关于授权
365+
### 5.3 关于授权
417366
smart-mqtt 以年订阅制的形式提供商业授权,每年的定价会随着项目自身发展状况而有所调整。客户可根据当年定价购买任意年限的授权,从而不受后续价格波动影响。
418367

419368
| 年份 |价格|

0 commit comments

Comments
 (0)