Chapter 2. API Reference
(continued from previous page)
total_invoked - number of times this handler has been invoked
total_runtime - total amount of time used for invoking this handler
Note this function is a noop when CONFIG_ESP_EVENT_LOOP_PROFILING is disabled
Return
• ESP_OK: Success
• ESP_ERR_NO_MEM: Cannot allocate memory for event loops list
• Others: Fail
Parameters
• [in] file: the file stream to output to
Structures
struct esp_event_loop_args_t
Configuration for creating event loops.
Public Members
int32_t queue_size
size of the event loop queue
const char *task_name
name of the event loop task; if NULL, a dedicated task is not created for event loop
UBaseType_t task_priority
priority of the event loop task, ignored if task name is NULL
uint32_t task_stack_size
stack size of the event loop task, ignored if task name is NULL
BaseType_t task_core_id
core to which the event loop task is pinned to, ignored if task name is NULL
Header File
• components/esp_event/include/esp_event_base.h
Macros
ESP_EVENT_DECLARE_BASE(id)
ESP_EVENT_DEFINE_BASE(id)
ESP_EVENT_ANY_BASE
register handler for any event base
ESP_EVENT_ANY_ID
register handler for any event id
Type Definitions
typedef const char *esp_event_base_t
unique pointer to a subsystem that exposes events
typedef void *esp_event_loop_handle_t
a number that identifies an event with respect to a base
typedef void (*esp_event_handler_t)(void *event_handler_arg, esp_event_base_t event_base,
int32_t event_id, void *event_data)
function called when an event is posted to the queue
typedef void *esp_event_handler_instance_t
context identifying an instance of a registered event handler
Espressif Systems 845
Submit Document Feedback
Release v4.4
To Next Page
Loading...