From 971546a49d3d6149216e2957373cf2814ba25521 Mon Sep 17 00:00:00 2001 From: Luffy <52o@qq52o.cn> Date: Thu, 15 Jan 2026 11:11:19 +0800 Subject: [PATCH] Update ping method docs --- .github/workflows/phpstan.yml | 2 +- docs/en/client.md | 6 +++++- docs/en/websocket.md | 6 +++++- docs/zh-cn/client.md | 4 +++- docs/zh-cn/websocket.md | 4 +++- 5 files changed, 17 insertions(+), 5 deletions(-) diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml index d95c263..eac1bfe 100644 --- a/.github/workflows/phpstan.yml +++ b/.github/workflows/phpstan.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - php-version: [ '8.1', '8.2', '8.3', '8.4', '8.5' ] + php-version: [ '8.1', '8.2', '8.3', '8.4' ] max-parallel: 5 fail-fast: false steps: diff --git a/docs/en/client.md b/docs/en/client.md index b776cf8..6cb3ec7 100644 --- a/docs/en/client.md +++ b/docs/en/client.md @@ -186,9 +186,13 @@ Simps\MQTT\Client->recv(): bool|arary|string Send a heartbeat ```php -Simps\MQTT\Client->ping() +Simps\MQTT\Client->ping(bool $response = true) ``` +- `bool $response` + +Whether a response is required. If `true`, `recv()` is called once + ## buildMessageId() Generate MessageId diff --git a/docs/en/websocket.md b/docs/en/websocket.md index 40846de..0c1eb92 100644 --- a/docs/en/websocket.md +++ b/docs/en/websocket.md @@ -186,9 +186,13 @@ Simps\MQTT\WebSocketClient->recv(): bool|arary|string Send a heartbeat ```php -Simps\MQTT\WebSocketClient->ping() +Simps\MQTT\WebSocketClient->ping(bool $response = true) ``` +- `bool $response` + +Whether a response is required. If `true`, `recv()` is called once + ## buildMessageId() Generate MessageId diff --git a/docs/zh-cn/client.md b/docs/zh-cn/client.md index 76c015a..10521db 100644 --- a/docs/zh-cn/client.md +++ b/docs/zh-cn/client.md @@ -205,9 +205,11 @@ Simps\MQTT\Client->recv(): bool|arary|string 发送心跳包 ```php -Simps\MQTT\Client->ping() +Simps\MQTT\Client->ping(bool $response = true) ``` +- 参数`$response` 是否需要回执。如果为`true`,会调用一次`recv()` + ## buildMessageId() 生成 MessageId diff --git a/docs/zh-cn/websocket.md b/docs/zh-cn/websocket.md index 36c0bd1..501b8f9 100644 --- a/docs/zh-cn/websocket.md +++ b/docs/zh-cn/websocket.md @@ -205,9 +205,11 @@ Simps\MQTT\WebSocketClient->recv(): bool|arary|string 发送心跳包 ```php -Simps\MQTT\WebSocketClient->ping() +Simps\MQTT\WebSocketClient->ping(bool $response = true) ``` +- 参数`$response` 是否需要回执。如果为`true`,会调用一次`recv()` + ## buildMessageId() 生成 MessageId