esp_task_wdt_add_user() function

Subscribe a user to the Task Watchdog Timer (TWDT) This function subscribes a user to the TWDT. A user of the TWDT is usually a function that needs to run periodically. Each subscribed user must periodically call esp_task_wdt_reset_user() to prevent the TWDT from elapsing its timeout period. Failure to do so will result in a TWDT timeout.

Syntax

Show:

Summary

Declaration

Definition

from esp_task_wdt.h:105

esp_err_t esp_task_wdt_add_user(const char *user_name, esp_task_wdt_user_handle_t *user_handle_ret);

Implemented in task_wdt.c:681

Arguments

Argument

Description

user_name

String to identify the user

user_handle_ret

Handle of the user

Return value

- ESP_OK: Successfully subscribed the user to the TWDT - Other: Failed to subscribe user

Examples

esp_task_wdt_add_user() is referenced by 1 libraries and example projects:

References

from examples

esp_task_wdt_add_user() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle