mirror of
https://github.com/espressif/esp-idf.git
synced 2025-12-07 09:02:08 +00:00
54 lines
1.7 KiB
C
54 lines
1.7 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
#include <stdbool.h>
|
|
#include "../esp_log_level.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Checks if a log message with the given log level and tag should be logged.
|
|
*
|
|
* @param level The log level of the message.
|
|
* @param tag The tag associated with the message.
|
|
* @return true if the log message can be logged,
|
|
* false otherwise.
|
|
*/
|
|
bool esp_log_is_tag_loggable(esp_log_level_t level, const char *tag);
|
|
|
|
/**
|
|
* @brief Set the default log level.
|
|
*
|
|
* This function sets the default log level used by the ESP-IDF log library.
|
|
* The default log level is used by the definition of ESP_LOGx macros and
|
|
* can be overridden for specific tags using `esp_log_level_set("*", level)`.
|
|
* This is for internal use only.
|
|
*
|
|
* If CONFIG_LOG_DYNAMIC_LEVEL_CONTROL is not set, this function does not change the default log level.
|
|
*
|
|
* @param level The new default log level to set.
|
|
*/
|
|
void esp_log_set_default_level(esp_log_level_t level);
|
|
|
|
/**
|
|
* @brief Get log level for a given tag, can be used to avoid expensive log statements
|
|
*
|
|
* The function takes the lock before checking the tag level,
|
|
* if the lock wait time exceeds 10 ms (default), then ESP_LOG_NONE is returned.
|
|
*
|
|
* @param tag Tag of the log to query current level. Must be a zero terminated string.
|
|
* If tag is NULL then the default log level is returned (see esp_log_get_default_level()).
|
|
* @return The current log level for the given tag.
|
|
*/
|
|
esp_log_level_t esp_log_level_get_timeout(const char *tag);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|