From fa020d036f702a0b702dee8b6ba45a49b8ed62b1 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Thu, 20 Oct 2022 15:30:52 +0800 Subject: [PATCH 1/6] chore(docs): translate Max Awaiting PUBREL confs --- apps/emqx/i18n/emqx_schema_i18n.conf | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index 17e59a4dd..ae9da4579 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -869,23 +869,25 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_max_awaiting_rel { desc { - en: """Maximum QoS 2 packets (Client -> Broker) awaiting PUBREL.""" - zh: """PUBREL (Client -> Broker) 最大等待队列长度。""" + en: """EMQX creates a wait queue in the client's session to accept QoS 2 messages from the client until this QoS 2 message transmission is complete or is discarded due to timeout.
+After this queue is full, the processing of QoS 2 messages will be stopped.""" + zh: """EMQX 会在客户端的会话中创建一个等待队列来接受客户端的 QoS 2 消息，直到这条 QoS 2 消息传输完成或由于超时被丢弃。
+该队列满后会停止处理 QoS 2 消息。""" } label: { en: """Max Awaiting PUBREL""" - zh: """Max Awaiting PUBREL""" + zh: """PUBREL 等待队列长度""" } } mqtt_await_rel_timeout { desc { - en: """The QoS 2 messages (Client -> Broker) will be dropped if awaiting PUBREL timeout.""" - zh: """PUBREL (Client -> Broker) 最大等待时间，超时则会被丢弃。""" + en: """The QoS 2 messages (Client -> Broker) handle flow will be ignored if awaiting PUBREL timeout. This QoS 2 message can be published successfully.""" + zh: """如果等待 PUBREL 超时，QoS 2消息（Client -> Broker）处理流程将被忽略。这条 QoS 2 仍然会成功发布。""" } label: { en: """Max Awaiting PUBREL TIMEOUT""" - zh: """Max Awaiting PUBREL TIMEOUT""" + zh: """PUBREL 最大等待时间""" } } From 72a228c52136f5a3ce1ec3d6e27ed91a7306513c Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 21 Oct 2022 09:53:31 +0800 Subject: [PATCH 2/6] chore: update apps/emqx/i18n/emqx_schema_i18n.conf Co-authored-by: Zaiming (Stone) Shi --- apps/emqx/i18n/emqx_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index ae9da4579..81e9c96dc 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -869,7 +869,7 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_max_awaiting_rel { desc { - en: """EMQX creates a wait queue in the client's session to accept QoS 2 messages from the client until this QoS 2 message transmission is complete or is discarded due to timeout.
+ en: """For each publisher session, the maximum number of outstanding QoS 2 messages pending on the client to send PUBREL. After reaching this limit, new QoS 2 PUBLISH requests will be rejected with reason code `147(0x93)` until either PUBREL is received or timed out.
After this queue is full, the processing of QoS 2 messages will be stopped.""" zh: """EMQX 会在客户端的会话中创建一个等待队列来接受客户端的 QoS 2 消息，直到这条 QoS 2 消息传输完成或由于超时被丢弃。
该队列满后会停止处理 QoS 2 消息。""" From 6d232fda5c1a2a99f5fc606013e34ddcf97f0933 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 21 Oct 2022 10:27:20 +0800 Subject: [PATCH 3/6] chore(i18n): improve the max_awaiting_rel desc --- apps/emqx/i18n/emqx_schema_i18n.conf | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index 81e9c96dc..5e4823992 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -869,10 +869,8 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_max_awaiting_rel { desc { - en: """For each publisher session, the maximum number of outstanding QoS 2 messages pending on the client to send PUBREL. After reaching this limit, new QoS 2 PUBLISH requests will be rejected with reason code `147(0x93)` until either PUBREL is received or timed out.
-After this queue is full, the processing of QoS 2 messages will be stopped.""" - zh: """EMQX 会在客户端的会话中创建一个等待队列来接受客户端的 QoS 2 消息，直到这条 QoS 2 消息传输完成或由于超时被丢弃。
-该队列满后会停止处理 QoS 2 消息。""" + en: """For each publisher session, the maximum number of outstanding QoS 2 messages pending on the client to send PUBREL. After reaching this limit, new QoS 2 PUBLISH requests will be rejected with reason code `147(0x93)` until either PUBREL is received or timed out.""" + zh: """每个发布者的会话中，都存在一个队列来处理客户端发送的 QoS 2 消息。该队列会存储 QoS 2 消息的报文 ID 直到收到客户端的 PUBREL 或超时，达到队列长度的限制后，新的 QoS 2 消息发布会被拒绝，并返回 `147(0x93)` 错误。""" } label: { en: """Max Awaiting PUBREL""" From 49dd25cb1438e24603b852e2fab6c711d7aeb802 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 21 Oct 2022 14:38:46 +0800 Subject: [PATCH 4/6] chore: make spellcheck happy --- apps/emqx/i18n/emqx_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index 5e4823992..e0a8e2995 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -869,7 +869,7 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_max_awaiting_rel { desc { - en: """For each publisher session, the maximum number of outstanding QoS 2 messages pending on the client to send PUBREL. After reaching this limit, new QoS 2 PUBLISH requests will be rejected with reason code `147(0x93)` until either PUBREL is received or timed out.""" + en: """For each publisher session, the maximum number of outstanding QoS 2 messages pending on the client to send PUBREL. After reaching this limit, new QoS 2 PUBLISH requests will be rejected with `147(0x93)` until either PUBREL is received or timed out.""" zh: """每个发布者的会话中，都存在一个队列来处理客户端发送的 QoS 2 消息。该队列会存储 QoS 2 消息的报文 ID 直到收到客户端的 PUBREL 或超时，达到队列长度的限制后，新的 QoS 2 消息发布会被拒绝，并返回 `147(0x93)` 错误。""" } label: { From 0f03449b43ae30a9d714ec4c8a194f379c7fabbb Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 21 Oct 2022 16:08:09 +0800 Subject: [PATCH 5/6] chore: improve max_awating_rel_timeout conf docs Co-authored-by: Zaiming (Stone) Shi --- apps/emqx/i18n/emqx_schema_i18n.conf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index e0a8e2995..d4dae31c7 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -880,8 +880,8 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_await_rel_timeout { desc { - en: """The QoS 2 messages (Client -> Broker) handle flow will be ignored if awaiting PUBREL timeout. This QoS 2 message can be published successfully.""" - zh: """如果等待 PUBREL 超时，QoS 2消息（Client -> Broker）处理流程将被忽略。这条 QoS 2 仍然会成功发布。""" + en: """For client to broker QoS 2 message, the time limit for the broker to wait before the `PUBREL` message is received. The wait is aborted after timed out, and receiving a stale `PUBREL` causes a warning level log. Note, the message is delivered to subscribers before entering the wait for PUBREL.""" + zh: """客户端发布 QoS 2 消息时，服务器等待 `PUBREL` 的最长时延。超过该时长后服务器会放弃等待，如果在这之后收到 PUBREL，服务器将会产生一条告警日志。注意，向订阅客户端转发消息的动作发生在进入等待之前。""" } label: { en: """Max Awaiting PUBREL TIMEOUT""" From ca052bd0f4559df7b7b647ce1a0257e79eaf8c61 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Fri, 21 Oct 2022 17:28:49 +0200 Subject: [PATCH 6/6] docs: Update apps/emqx/i18n/emqx_schema_i18n.conf --- apps/emqx/i18n/emqx_schema_i18n.conf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index d4dae31c7..94aae19cf 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -880,8 +880,8 @@ When set to true, invalid utf8 strings in for example client ID, topic name, etc mqtt_await_rel_timeout { desc { - en: """For client to broker QoS 2 message, the time limit for the broker to wait before the `PUBREL` message is received. The wait is aborted after timed out, and receiving a stale `PUBREL` causes a warning level log. Note, the message is delivered to subscribers before entering the wait for PUBREL.""" - zh: """客户端发布 QoS 2 消息时，服务器等待 `PUBREL` 的最长时延。超过该时长后服务器会放弃等待，如果在这之后收到 PUBREL，服务器将会产生一条告警日志。注意，向订阅客户端转发消息的动作发生在进入等待之前。""" + en: """For client to broker QoS 2 message, the time limit for the broker to wait before the `PUBREL` message is received. The wait is aborted after timed out, meaning the packet ID is freed for new `PUBLISH` requests. Receiving a stale `PUBREL` causes a warning level log. Note, the message is delivered to subscribers before entering the wait for PUBREL.""" + zh: """客户端发布 QoS 2 消息时，服务器等待 `PUBREL` 的最长时延。超过该时长后服务器会放弃等待，该PACKET ID 会被释放，从而允许后续新的 PUBLISH 消息使用。如果超时后收到 PUBREL，服务器将会产生一条告警日志。注意，向订阅客户端转发消息的动作发生在进入等待之前。""" } label: { en: """Max Awaiting PUBREL TIMEOUT"""