core_sntp_config_defaults.h File Reference

This file represents the default values for the configuration macros of the coreSNTP library. More...

Go to the source code of this file.

Macros
#define	SNTP_DO_NOT_USE_CUSTOM_CONFIG
	Define this macro to build the SNTP library without the custom config file core_sntp_config.h. More...
#define	LogError(message)
	Macro that is called in the SNTP library for logging "Error" level messages. More...
#define	LogWarn(message)
	Macro that is called in the SNTP library for logging "Warning" level messages. More...
#define	LogInfo(message)
	Macro that is called in the SNTP library for logging "Info" level messages. More...
#define	LogDebug(message)
	Macro that is called in the SNTP library for logging "Debug" level messages. More...

Detailed Description

This file represents the default values for the configuration macros of the coreSNTP library.

Note

This file SHOULD NOT be modified. If custom values are needed for any configuration macro, a core_sntp_config.h file should be provided to the SNTP library to override the default values defined in this file. To build the library with the core_sntp_config.h file, make sure to not set the SNTP_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro.

Macro Definition Documentation

SNTP_DO_NOT_USE_CUSTOM_CONFIG

#define SNTP_DO_NOT_USE_CUSTOM_CONFIG

Define this macro to build the SNTP library without the custom config file core_sntp_config.h.

Without the custom config, the SNTP library builds with default values of config macros defined in core_sntp_config_defaults.h file.

If a custom config is provided, then SNTP_DO_NOT_USE_CUSTOM_CONFIG should not be defined.

LogError

#define LogError

(

message

)

Macro that is called in the SNTP library for logging "Error" level messages.

To enable error level logging in the SNTP library, this macro should be mapped to the application-specific logging implementation that supports error logging.

Note

This logging macro is called in the SNTP 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_sntp_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 SNTP library on compilation.

LogWarn

#define LogWarn

(

message

)

Macro that is called in the SNTP library for logging "Warning" level messages.

To enable warning level logging in the SNTP library, this macro should be mapped to the application-specific logging implementation that supports warning logging.

Note

This logging macro is called in the SNTP 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_sntp_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 SNTP library on compilation.

LogInfo

#define LogInfo

(

message

)

Macro that is called in the SNTP library for logging "Info" level messages.

To enable info level logging in the SNTP library, this macro should be mapped to the application-specific logging implementation that supports info logging.

Note

This logging macro is called in the SNTP 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_sntp_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 SNTP library on compilation.

LogDebug

#define LogDebug

(

message

)

Macro that is called in the SNTP library for logging "Debug" level messages.

To enable debug level logging from SNTP library, this macro should be mapped to the application-specific logging implementation that supports debug logging.

Note

This logging macro is called in the SNTP 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_sntp_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 SNTP library on compilation.