Ajax::Logging Namespace Reference

The 'Logging' namespace provides the Ajax and Eros Application specific logging Categories and Message IDs. More...

Detailed Description

The 'Logging' namespace provides the Ajax and Eros Application specific logging Categories and Message IDs.

Functions
	BETTER_ENUM (AlertMsg, uint16_t, FAILED_SAFE, NO_TEMPERATURE_SENSOR)
	This enumeration defines Logging message code for the Alert category.
void	logf (CriticalMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a CRITICAL log entry.
void	logf (WarningMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a WARNING log entry.
void	logf (EventMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a EVENT log entry.
void	logf (AlertMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a ALERT log entry.
void	logf (InfoMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a INFO log entry.
void	logf (MetricsMsg msgId, const char *msgTextFormat,...) noexcept
	This method logs a METRICS log entry.
	BETTER_ENUM (CategoryId, uint32_t, CRITICAL=0x0001, WARNING=0x0002, ALERT=0x0004, EVENT=0x0008, INFO=0x0010, METRICS=0x0020)
	This enumeration defines the various logging categories.
	BETTER_ENUM (CriticalMsg, uint16_t, DRIVER, DIVIDE_BY_ZERO, UX_ERROR, FATAL_ERROR)
	This enumeration defines Logging message code for the CRITICAL category.
	BETTER_ENUM (EventMsg, uint16_t, PLACE_HOLDER)
	This enumeration defines Logging message code for the EVENT category.
	BETTER_ENUM (InfoMsg, uint16_t, HEATING_ALGO)
	This enumeration defines Logging message code for the Information category.
	BETTER_ENUM (MetricsMsg, uint16_t, POWER_ON, SHUTDOWN)
	This enumeration defines Logging message code for the METRICS category.
	BETTER_ENUM (WarningMsg, uint16_t, LOGGING_OVERFLOW, OPEN_CLOSE, OUT_OF_MEMORY)
	This enumeration defines Logging message code for the WARNING category.

Function Documentation

BETTER_ENUM() [1/7]

Ajax::Logging::BETTER_ENUM	(	AlertMsg	,
		uint16_t	,
		FAILED_SAFE	,
		NO_TEMPERATURE_SENSOR
	)

This enumeration defines Logging message code for the Alert category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

AlertMsg	Enum
FAILED_SAFE	The hardware hi-temperature safety limit Alert
NO_TEMPERATURE_SENSOR	No available/working space temperature sensor Alert

BETTER_ENUM() [2/7]

Ajax::Logging::BETTER_ENUM	(	CategoryId	,
		uint32_t	,
		CRITICAL	= 0x0001,
		WARNING	= 0x0002,
		ALERT	= 0x0004,
		EVENT	= 0x0008,
		INFO	= 0x0010,
		METRICS	= 0x0020
	)

This enumeration defines the various logging categories.

Note: Each symbol must be less than 16 characters 123456789 123456

Parameters

CategoryId	Enum
CRITICAL	A sub-system/module encountered an unrecoverable error – but the overall System can still provide some level of functionality.
WARNING	A recoverable error and/or an unexpected condition occurred
EVENT	An ‘interesting’ event or action occurred
ALERT	An alert condition or state was encounter (aka a UX Alert)
INFO	Informational. Typically used for detailed troubleshooting and is not recommended to be enabled by default
METRICS	Used to capture metrics to the device’s log file. Expected usage is that the metrics are periodically written the log file.

BETTER_ENUM() [3/7]

Ajax::Logging::BETTER_ENUM	(	CriticalMsg	,
		uint16_t	,
		DRIVER	,
		DIVIDE_BY_ZERO	,
		UX_ERROR	,
		FATAL_ERROR
	)

This enumeration defines Logging message code for the CRITICAL category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

CriticalMsg	Enum
DRIVER	An unrecoverable driver error occurred
DIVIDE_BY_ZERO	Calculation was aborted because the denominator was zero
UX_ERROR	An error occurred that prevented proper operation of the Display and/or user buttons
FATAL_ERROR	An Fatal error was logged using the CPL FatalError handler

BETTER_ENUM() [4/7]

Ajax::Logging::BETTER_ENUM	(	EventMsg	,
		uint16_t	,
		PLACE_HOLDER
	)

This enumeration defines Logging message code for the EVENT category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

EventMsg	Enum
PLACE_HOLDER	Place holder till I have a event log entry

BETTER_ENUM() [5/7]

Ajax::Logging::BETTER_ENUM	(	InfoMsg	,
		uint16_t	,
		HEATING_ALGO
	)

This enumeration defines Logging message code for the Information category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

InfoMsg	Enum
HEATING_ALGO	Event/condition will executing the heating algorithm

BETTER_ENUM() [6/7]

Ajax::Logging::BETTER_ENUM	(	MetricsMsg	,
		uint16_t	,
		POWER_ON	,
		SHUTDOWN
	)

This enumeration defines Logging message code for the METRICS category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

MetricsMsg	Enum
POWER_ON	The MCU was powered and/or was reset
SHUTDOWN	An orderly shutdown of the application was initiated

BETTER_ENUM() [7/7]

Ajax::Logging::BETTER_ENUM	(	WarningMsg	,
		uint16_t	,
		LOGGING_OVERFLOW	,
		OPEN_CLOSE	,
		OUT_OF_MEMORY
	)

This enumeration defines Logging message code for the WARNING category.

Note: Each error code symbol must be less than 32 characters
   123456789 123456789 12345678 12

Parameters

WarningMsg	Enum
LOGGING_OVERFLOW	The Logging Queue overflowed (and has not recovered)
OPEN_CLOSE	Incorrect open()/close() semantics (e.g. call open() twice in row)
OUT_OF_MEMORY	A non-fatal out-of-memory condition was encounter

logf() [1/6]

void Ajax::Logging::logf ( AlertMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a ALERT log entry.

logf() [2/6]

void Ajax::Logging::logf ( CriticalMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a CRITICAL log entry.

logf() [3/6]

void Ajax::Logging::logf ( EventMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a EVENT log entry.

logf() [4/6]

void Ajax::Logging::logf ( InfoMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a INFO log entry.

logf() [5/6]

void Ajax::Logging::logf ( MetricsMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a METRICS log entry.

logf() [6/6]

void Ajax::Logging::logf ( WarningMsg  msgId, const char *  msgTextFormat,   ...  )

noexcept

This method logs a WARNING log entry.