cdi_log_enums.h File Reference

This file declares the public enum data types that are part of the CDI log API. More...

Go to the source code of this file.

Enumerations
enum	CdiLogMethod { kLogMethodStdout , kLogMethodCallback , kLogMethodFile }
	This selector determines the log method to use for generating log messages within the SDK. NOTE: Any changes made here MUST also be made to "log_method_key_array" in utilities_api.c. More...
enum	CdiLogComponent {   kLogComponentGeneric , kLogComponentPayloadConfig , kLogComponentPerformanceMetrics , kLogComponentProbe ,   kLogComponentEndpointManager , kLogComponentLast }
	This selector determines the SDK component type for logging. Logging for it can be enabled/disabled using CdiLogComponentEnable(). NOTE: Any changes made here MUST also be made to "log_component_key_array" in utilities_api.c. More...
enum	CdiLogLevel {   kLogFatal , kLogCritical , kLogError , kLogWarning ,   kLogInfo , kLogVerbose , kLogDebug , kLogLast }
	This selector determines the log level of messages generated using the CdiLogMessageCallback(). The log level can be set individually for log components using CdiCoreLogLevelSet(). NOTE: Any changes made here MUST also be made to "log_level_key_array" in utilities_api.c. More...

Detailed Description

This file declares the public enum data types that are part of the CDI log API.

Enumeration Type Documentation

CdiLogComponent

enum CdiLogComponent

This selector determines the SDK component type for logging. Logging for it can be enabled/disabled using CdiLogComponentEnable(). NOTE: Any changes made here MUST also be made to "log_component_key_array" in utilities_api.c.

Enumerator
kLogComponentGeneric	Generic component.
kLogComponentPayloadConfig	Payload configuration data component.
kLogComponentPerformanceMetrics	Performance metrics component.
kLogComponentProbe	Probe component.
kLogComponentEndpointManager	Endpoint Manager component.
kLogComponentLast	Must be last entry. Used for range checking. Do not remove.

CdiLogLevel

enum CdiLogLevel

This selector determines the log level of messages generated using the CdiLogMessageCallback(). The log level can be set individually for log components using CdiCoreLogLevelSet(). NOTE: Any changes made here MUST also be made to "log_level_key_array" in utilities_api.c.

Enumerator
kLogFatal	Fatal errors are not recoverable. Software needs to exit.
kLogCritical	Critical errors are logged. Software may continue but something is very wrong.
kLogError	Errors to the user.
kLogWarning	Warnings to the user.
kLogInfo	General information to the user.
kLogVerbose	Additional verbose information to the user.
kLogDebug	Debug information to the user.
kLogLast	Must be last entry. Used for range checking. Do not remove.

CdiLogMethod

enum CdiLogMethod

This selector determines the log method to use for generating log messages within the SDK. NOTE: Any changes made here MUST also be made to "log_method_key_array" in utilities_api.c.

Enumerator
kLogMethodStdout	Send log messages directly to stdout.
kLogMethodCallback	Send log messages to a user-registered callback function.
kLogMethodFile	Write log messages directly to a file.