espressif/esp-mqtt
1
0
Fork 1
mirror of https://github.com/espressif/esp-mqtt.git synced 2025-07-31 19:25:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify keepalive timeout

Browse Source 
Adds information on the behavior of the PINGREQ message timeout and some
reasoning behind the choice.
This commit is contained in:
Rocha Euripedes
2023-07-11 05:34:46 +08:00
parent cd81773bd1
commit cb1e6cf218
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
include/mqtt_client.h
View File

@@ -315,7 +315,10 @@ typedef struct esp_mqtt_client_config_t {
int retain; /*!< LWT retained message flag */ int retain; /*!< LWT retained message flag */
} last_will; /*!< Last will configuration */ } last_will; /*!< Last will configuration */
bool disable_clean_session; /*!< *MQTT* clean session, default clean_session is true */ bool disable_clean_session; /*!< *MQTT* clean session, default clean_session is true */
int keepalive; /*!< *MQTT* keepalive, default is 120 seconds */ int keepalive; /*!< *MQTT* keepalive, default is 120 seconds
When configuring this value, keep in mind that the client attempts
to communicate with the broker at half the interval that is actually set.
This conservative approach allows for more attempts before the broker's timeout occurs */
bool disable_keepalive; /*!< Set `disable_keepalive=true` to turn off keep-alive mechanism, keepalive is active bool disable_keepalive; /*!< Set `disable_keepalive=true` to turn off keep-alive mechanism, keepalive is active
by default. Note: setting the config value `keepalive` to `0` doesn't disable by default. Note: setting the config value `keepalive` to `0` doesn't disable
keepalive feature, but uses a default keepalive period */ keepalive feature, but uses a default keepalive period */