esp_event_post() function

Posts an event to the system default event loop. The event loop library keeps a copy of event_data and manages the copy's lifetime automatically (allocation + deletion); this ensures that the data the handler receives is always valid.

Syntax

Show:

Summary

Declaration

Definition

from esp_event.h:363

esp_err_t esp_event_post(esp_event_base_t event_base, int32_t event_id, const void *event_data, size_t event_data_size, TickType_t ticks_to_wait);

Implemented in default_event_loop.c:68

Arguments

Argument

Description

event_base

the event base that identifies the event

event_id

the event ID that identifies the event

event_data

the data, specific to the event occurrence, that gets passed to the handler

event_data_size

the size of the event data

ticks_to_wait

number of ticks to block on a full event queue

Return value

- ESP_OK: Success - ESP_ERR_TIMEOUT: Time to wait for event queue to unblock expired, queue full when posting from ISR - ESP_ERR_INVALID_ARG: Invalid combination of event base and event ID - Others: Fail

Examples

esp_event_post() is referenced by 4 libraries and example projects:

References

from examples

esp_event_post() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle