Merge branch 'bugfix/mqtt_docs_custom_outbox' into 'master'

mqtt: Add docs on MQTT_CUSTOM_OUTBOX implementation

Closes IDFGH-6554

See merge request espressif/esp-idf!16828
This commit is contained in:
David Čermák 2022-01-18 09:39:35 +00:00
commit 0fa3c5b331

View File

@ -137,8 +137,12 @@ menu "ESP-MQTT Configurations"
bool "Enable custom outbox implementation"
default n
help
Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or
Set to true if a specific implementation of message outbox is needed (e.g. persistent outbox in NVM or
similar).
Note: Implementation of the custom outbox must be added to the mqtt component. These CMake commands
could be used to append the custom implementation to lib-mqtt sources:
idf_component_get_property(mqtt mqtt COMPONENT_LIB)
set_property(TARGET ${mqtt} PROPERTY SOURCES ${PROJECT_DIR}/custom_outbox.c APPEND)
config MQTT_OUTBOX_EXPIRED_TIMEOUT_MS
int "Outbox message expired timeout[ms]"