coreMQTT Agent v1.2.0
Thread safe MQTT 3.1.1 Client
core_mqtt_agent_default_logging.h File Reference

This represents the default values for the logging macros for the MQTT-Agent library. More...

Go to the source code of this file.

Macros

#define LogError(message)
 Macro that is called in the MQTT-Agent library for logging "Error" level messages. More...
 
#define LogWarn(message)
 Macro that is called in the MQTT-Agent library for logging "Warning" level messages. More...
 
#define LogInfo(message)
 Macro that is called in the MQTT-Agent library for logging "Info" level messages. More...
 
#define LogDebug(message)
 Macro that is called in the MQTT-Agent library for logging "Debug" level messages. More...
 

Detailed Description

This represents the default values for the logging macros for the MQTT-Agent library.

Note
This file SHOULD NOT be modified. If custom values are needed for any configuration macro, a core_mqtt_agent_config.h file should be provided to the MQTT-Agent library to override the default values defined in this file. To use the custom config file, the MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro SHOULD NOT be set.

Macro Definition Documentation

◆ LogError

#define LogError (   message)

Macro that is called in the MQTT-Agent library for logging "Error" level messages.

To enable error level logging in the MQTT-Agent 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-Agent 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.

Default value: Error logging is turned off, and no code is generated for calls to the macro in the MQTT library on compilation.

◆ LogWarn

#define LogWarn (   message)

Macro that is called in the MQTT-Agent library for logging "Warning" level messages.

To enable warning level logging in the MQTT-Agent 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-Agent 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.

Default value: Warning logs are turned off, and no code is generated for calls to the macro in the MQTT library on compilation.

◆ LogInfo

#define LogInfo (   message)

Macro that is called in the MQTT-Agent library for logging "Info" level messages.

To enable info level logging in the MQTT-Agent 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-Agent 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.

Default value: Info logging is turned off, and no code is generated for calls to the macro in the MQTT library on compilation.

◆ LogDebug

#define LogDebug (   message)

Macro that is called in the MQTT-Agent library for logging "Debug" level messages.

To enable debug level logging from MQTT-Agent 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-Agent 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.

Default value: Debug logging is turned off, and no code is generated for calls to the macro in the MQTT library on compilation.