diff --git a/source/core_mqtt.c b/source/core_mqtt.c index 8b72c5d17..92a93b697 100644 --- a/source/core_mqtt.c +++ b/source/core_mqtt.c @@ -35,8 +35,6 @@ /* Include config defaults header to get default values of configs. */ #include "core_mqtt_config_defaults.h" -#include "core_mqtt_default_logging.h" - #ifndef MQTT_PRE_SEND_HOOK /** diff --git a/source/core_mqtt_serializer.c b/source/core_mqtt_serializer.c index 537925996..91f968bbe 100644 --- a/source/core_mqtt_serializer.c +++ b/source/core_mqtt_serializer.c @@ -34,8 +34,6 @@ /* Include config defaults header to get default values of configs. */ #include "core_mqtt_config_defaults.h" -#include "core_mqtt_default_logging.h" - /** * @brief MQTT protocol version 3.1.1. */ diff --git a/source/core_mqtt_state.c b/source/core_mqtt_state.c index 9cd1f221c..cabc81622 100644 --- a/source/core_mqtt_state.c +++ b/source/core_mqtt_state.c @@ -33,8 +33,6 @@ /* Include config defaults header to get default values of configs. */ #include "core_mqtt_config_defaults.h" -#include "core_mqtt_default_logging.h" - /*-----------------------------------------------------------*/ /** diff --git a/source/include/core_mqtt_config_defaults.h b/source/include/core_mqtt_config_defaults.h index a573967f9..136faf8a2 100644 --- a/source/include/core_mqtt_config_defaults.h +++ b/source/include/core_mqtt_config_defaults.h @@ -195,6 +195,86 @@ #error MQTT_SEND_RETRY_TIMEOUT_MS is deprecated. Instead use MQTT_SEND_TIMEOUT_MS. #endif +/** + * @brief Macro that is called in the MQTT library for logging "Error" level + * messages. + * + * To enable error level logging in the MQTT library, this macro should be mapped to the + * application-specific logging implementation that supports error logging. + * + * @note This logging macro is called in the MQTT library with parameters wrapped in + * double parentheses to be ISO C89/C90 standard compliant. For a reference + * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the + * logging-stack in demos folder of the + * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C). + * + * Default value: Error logging is turned off, and no code is generated for calls + * to the macro in the MQTT library on compilation. + */ +#ifndef LogError + #define LogError( message ) +#endif + +/** + * @brief Macro that is called in the MQTT library for logging "Warning" level + * messages. + * + * To enable warning level logging in the MQTT library, this macro should be mapped to the + * application-specific logging implementation that supports warning logging. + * + * @note This logging macro is called in the MQTT library with parameters wrapped in + * double parentheses to be ISO C89/C90 standard compliant. For a reference + * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the + * logging-stack in demos folder of the + * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). + * + * Default value: Warning logs are turned off, and no code is generated for calls + * to the macro in the MQTT library on compilation. + */ +#ifndef LogWarn + #define LogWarn( message ) +#endif + +/** + * @brief Macro that is called in the MQTT library for logging "Info" level + * messages. + * + * To enable info level logging in the MQTT library, this macro should be mapped to the + * application-specific logging implementation that supports info logging. + * + * @note This logging macro is called in the MQTT library with parameters wrapped in + * double parentheses to be ISO C89/C90 standard compliant. For a reference + * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the + * logging-stack in demos folder of the + * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). + * + * Default value: Info logging is turned off, and no code is generated for calls + * to the macro in the MQTT library on compilation. + */ +#ifndef LogInfo + #define LogInfo( message ) +#endif + +/** + * @brief Macro that is called in the MQTT library for logging "Debug" level + * messages. + * + * To enable debug level logging from MQTT library, this macro should be mapped to the + * application-specific logging implementation that supports debug logging. + * + * @note This logging macro is called in the MQTT library with parameters wrapped in + * double parentheses to be ISO C89/C90 standard compliant. For a reference + * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the + * logging-stack in demos folder of the + * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). + * + * Default value: Debug logging is turned off, and no code is generated for calls + * to the macro in the MQTT library on compilation. + */ +#ifndef LogDebug + #define LogDebug( message ) +#endif + /* *INDENT-OFF* */ #ifdef __cplusplus } diff --git a/source/include/core_mqtt_default_logging.h b/source/include/core_mqtt_default_logging.h deleted file mode 100644 index 85f8011f0..000000000 --- a/source/include/core_mqtt_default_logging.h +++ /dev/null @@ -1,132 +0,0 @@ -/* - * coreMQTT v2.1.0 - * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * SPDX-License-Identifier: MIT - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -/** - * @file core_mqtt_default_logging.h - * @brief This represents the default values for the logging macros for the MQTT - * library. - * - * @note This file SHOULD NOT be modified. If custom values are needed for - * any configuration macro, a core_mqtt_config.h file should be provided to - * the MQTT library to override the default values defined in this file. - * To use the custom config file, the MQTT_DO_NOT_USE_CUSTOM_CONFIG preprocessor - * macro SHOULD NOT be set. - */ - -#ifndef CORE_MQTT_DEFAULT_LOGGING_H_ -#define CORE_MQTT_DEFAULT_LOGGING_H_ - -/* *INDENT-OFF* */ -#ifdef __cplusplus - extern "C" { -#endif -/* *INDENT-ON* */ - -/** - * @brief Macro that is called in the MQTT library for logging "Error" level - * messages. - * - * To enable error level logging in the MQTT library, this macro should be mapped to the - * application-specific logging implementation that supports error logging. - * - * @note This logging macro is called in the MQTT library with parameters wrapped in - * double parentheses to be ISO C89/C90 standard compliant. For a reference - * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the - * logging-stack in demos folder of the - * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C). - * - * Default value: Error logging is turned off, and no code is generated for calls - * to the macro in the MQTT library on compilation. - */ -#ifndef LogError - #define LogError( message ) -#endif - -/** - * @brief Macro that is called in the MQTT library for logging "Warning" level - * messages. - * - * To enable warning level logging in the MQTT library, this macro should be mapped to the - * application-specific logging implementation that supports warning logging. - * - * @note This logging macro is called in the MQTT library with parameters wrapped in - * double parentheses to be ISO C89/C90 standard compliant. For a reference - * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the - * logging-stack in demos folder of the - * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). - * - * Default value: Warning logs are turned off, and no code is generated for calls - * to the macro in the MQTT library on compilation. - */ -#ifndef LogWarn - #define LogWarn( message ) -#endif - -/** - * @brief Macro that is called in the MQTT library for logging "Info" level - * messages. - * - * To enable info level logging in the MQTT library, this macro should be mapped to the - * application-specific logging implementation that supports info logging. - * - * @note This logging macro is called in the MQTT library with parameters wrapped in - * double parentheses to be ISO C89/C90 standard compliant. For a reference - * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the - * logging-stack in demos folder of the - * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). - * - * Default value: Info logging is turned off, and no code is generated for calls - * to the macro in the MQTT library on compilation. - */ -#ifndef LogInfo - #define LogInfo( message ) -#endif - -/** - * @brief Macro that is called in the MQTT library for logging "Debug" level - * messages. - * - * To enable debug level logging from MQTT library, this macro should be mapped to the - * application-specific logging implementation that supports debug logging. - * - * @note This logging macro is called in the MQTT library with parameters wrapped in - * double parentheses to be ISO C89/C90 standard compliant. For a reference - * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the - * logging-stack in demos folder of the - * [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/). - * - * Default value: Debug logging is turned off, and no code is generated for calls - * to the macro in the MQTT library on compilation. - */ -#ifndef LogDebug - #define LogDebug( message ) -#endif - -/* *INDENT-OFF* */ -#ifdef __cplusplus - } -#endif -/* *INDENT-ON* */ - -#endif /* ifndef CORE_MQTT_DEFAULT_LOGGING_H_ */