Cpl::System::FatalError Class Reference

This class defines methods for handling fatal errors encountered by an application. More...

Detailed Description

This class defines methods for handling fatal errors encountered by an application.

The implementation of the methods is platform dependent.

#include <FatalError.h>

Static Public Member Functions
static void	log (const char *message)
	This function is used to process/log a FATAL error.
static void	log (const char *message, size_t value)
	Same as above, but "value" is also logged.
static void	logf (const char *format,...)
	Printf style formatted message.
static void	logRaw (const char *message)
	Same as log(..) method, except NO "...other useful info such as current task,..." is logged, AND the "storage media" is restricted to 'media' that is ALWAYS available.
static void	logRaw (const char *message, size_t value)
	Same as log(..) method, except NO 'extra info' and restricted media.

Member Function Documentation

log() [1/2]

static void Cpl::System::FatalError::log ( const char *  message )

static

This function is used to process/log a FATAL error.

The supplied error message will be logged to a "storage media" along with other useful info such as the current task, stack dump, etc. In addition, THE APPLICATION AND/OR SYSTEM WILL BE "STOPPED". Stopped can mean the application/system is exited, restarted, paused forever, etc. The type of "storage media", additional info, stopped behavior, etc. is defined by the selected/linked implementation.

NOTE: Applications, in general should NOT call this method - the application should be DESIGNED to handle and recover from errors that it encounters/detects.

log() [2/2]

static void Cpl::System::FatalError::log ( const char *  message, size_t  value  )

static

Same as above, but "value" is also logged.

This method allows additional information to be logged without resulting to a string formating call (which may not work since something really bad just happen).

logf()

static void Cpl::System::FatalError::logf ( const char *  format,   ...  )

static

Printf style formatted message.

logRaw() [1/2]

static void Cpl::System::FatalError::logRaw ( const char *  message )

static

Same as log(..) method, except NO "...other useful info such as current task,..." is logged, AND the "storage media" is restricted to 'media' that is ALWAYS available.

This allows routines that are supplying the extra info OR routines that write to media to be able to log fatal errors WITHOUT creating a recursive death loop.

logRaw() [2/2]

static void Cpl::System::FatalError::logRaw ( const char *  message, size_t  value  )

static

Same as log(..) method, except NO 'extra info' and restricted media.

---

The documentation for this class was generated from the following file:

• Cpl/System/FatalError.h