53de9f115f
This change separates definitions in esp_event.h and functions in event.c into several parts: - event structure definitions (esp_event.h) - default implementations of event handlers (event_default_handlers.c) - default implementation of event loop (event_loop.c, esp_event_loop.h) Purpose of this change is to allow applications choose their own poison: - full control of event loop at the expense of more bootstrap code - pre-defined event task firing event callbacks, but less code in app_main.c
82 lines
2.3 KiB
C
82 lines
2.3 KiB
C
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef __ESP_EVENT_LOOP_H__
|
|
#define __ESP_EVENT_LOOP_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include "esp_err.h"
|
|
#include "esp_event.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/queue.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Application specified event callback function
|
|
*
|
|
* @param void *ctx : reserved for user
|
|
* @param system_event_t *event : event type defined in this file
|
|
*
|
|
* @return ESP_OK : succeed
|
|
* @return others : fail
|
|
*/
|
|
typedef esp_err_t (*system_event_cb_t)(void *ctx, system_event_t *event);
|
|
|
|
/**
|
|
* @brief Initialize event loop
|
|
* Create the event handler and task
|
|
*
|
|
* @param system_event_cb_t cb : application specified event callback, it can be modified by call esp_event_set_cb
|
|
* @param void *ctx : reserved for user
|
|
*
|
|
* @return ESP_OK : succeed
|
|
* @return others : fail
|
|
*/
|
|
esp_err_t esp_event_loop_init(system_event_cb_t cb, void *ctx);
|
|
|
|
/**
|
|
* @brief Set application specified event callback function
|
|
*
|
|
* @attention 1. If cb is NULL, means application don't need to handle
|
|
* If cb is not NULL, it will be call when an event is received, after the default event callback is completed
|
|
*
|
|
* @param system_event_cb_t cb : callback
|
|
* @param void *ctx : reserved for user
|
|
*
|
|
* @return system_event_cb_t : old callback
|
|
*/
|
|
system_event_cb_t esp_event_loop_set_cb(system_event_cb_t cb, void *ctx);
|
|
|
|
/**
|
|
* @brief Get the queue used by event loop
|
|
*
|
|
* @attention : currently this API is used to initialize "q" parameter
|
|
* of wifi_init structure.
|
|
*
|
|
* @return QueueHandle_t : event queue handle
|
|
*/
|
|
QueueHandle_t esp_event_loop_get_queue(void);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ESP_EVENT_LOOP_H__ */
|