esp-idf/components/esp_event/private_include/esp_event_private.h
Darian Leung f50d83413e refactor(tools): Tidy up core component files copyright ignore
Some files that should have their copyrights checked are still placed on the
copyright ignore list.

- These entries have been tidied up
- Copyrights of those files have been updated.
2024-01-22 18:07:35 +08:00

48 lines
1.1 KiB
C

/*
* SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ESP_EVENT_PRIVATE_H_
#define ESP_EVENT_PRIVATE_H_
#include <stdbool.h>
#include "esp_event.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Searches handlers registered with an event loop to see if it has been registered.
*
* @param[in] event_loop the loop to search
* @param[in] event_base the event base to search
* @param[in] event_id the event id to search
* @param[in] event_handler the event handler to look for
*
* @return true handler registered
* @return false handler not registered
*
* @return
* - true: Handler registered
* - false: Handler not registered
*/
bool esp_event_is_handler_registered(esp_event_loop_handle_t event_loop, esp_event_base_t event_base, int32_t event_id, esp_event_handler_t event_handler);
/**
* @brief Deinitializes the event loop library
*
* @return
* - ESP_OK: Success
* - Others: Fail
*/
esp_err_t esp_event_loop_deinit(void);
#ifdef __cplusplus
} // extern "C"
#endif
#endif // #ifndef ESP_EVENT_PRIVATE_H_