Logging

This category contains functions and types for controlling logging output. More...

Data Structures
struct	fplLogSettings
	A structure containing log settings. More...
struct	fplLogWriter
	A structure containing log writer settings. More...
struct	fplLogWriterConsole
	A structure containing console logging properties. More...
struct	fplLogWriterCustom
	A structure containing properties custom logging properties. More...

Typedefs
typedef void()	fpl_log_func_callback(const char *funcName, const int lineNumber, const fplLogLevel level, const char *message)
	A callback for printing a log message.
typedef enum fplLogLevel	fplLogLevel
	An enumeration of log levels.
typedef struct fplLogSettings	fplLogSettings
	A structure containing log settings.
typedef struct fplLogWriter	fplLogWriter
	A structure containing log writer settings.
typedef struct fplLogWriterConsole	fplLogWriterConsole
	A structure containing console logging properties.
typedef struct fplLogWriterCustom	fplLogWriterCustom
	A structure containing properties custom logging properties.
typedef enum fplLogWriterFlags	fplLogWriterFlags
	An enumeration of log writer flags.

Enumerations
enum	fplLogLevel {   fplLogLevel_All , fplLogLevel_Critical , fplLogLevel_Error , fplLogLevel_Warning ,   fplLogLevel_Info , fplLogLevel_Verbose , fplLogLevel_Debug , fplLogLevel_Trace ,   fplLogLevel_First , fplLogLevel_Last }
	An enumeration of log levels. More...
enum	fplLogWriterFlags {   fplLogWriterFlags_None , fplLogWriterFlags_StandardConsole , fplLogWriterFlags_ErrorConsole , fplLogWriterFlags_DebugOut ,   fplLogWriterFlags_Custom }
	An enumeration of log writer flags. More...

Functions
	FPL_ENUM_AS_FLAGS_OPERATORS (fplLogWriterFlags)
	Log writer flags enumeration operators.
fpl_common_api const fplLogSettings *	fplGetLogSettings ()
	Gets the current log settings.
fpl_common_api fplLogLevel	fplGetMaxLogLevel ()
	Gets the current maximum allowed log level.
fpl_common_api void	fplSetLogSettings (const fplLogSettings *params)
	Overwrites the current log settings.
fpl_common_api void	fplSetMaxLogLevel (const fplLogLevel maxLevel)
	Changes the current maximum log level to the given value.

Detailed Description

This category contains functions and types for controlling logging output.

Typedef Documentation

fpl_log_func_callback

typedef void() fpl_log_func_callback(const char *funcName, const int lineNumber, const fplLogLevel level, const char *message)

A callback for printing a log message.

Parameters

funcName	The function name
lineNumber	The line number
level	The log level fplLogLevel
message	The log message string

See also

Example: Log all errors to a custom logging function

Definition at line 4205 of file final_platform_layer.h.

Enumeration Type Documentation

fplLogLevel

enum fplLogLevel

An enumeration of log levels.

Enumerator
fplLogLevel_All	All.
fplLogLevel_Critical	Critical.
fplLogLevel_Error	Error.
fplLogLevel_Warning	Warning.
fplLogLevel_Info	Info.
fplLogLevel_Verbose	Verbose.
fplLogLevel_Debug	Debug.
fplLogLevel_Trace	Trace.
fplLogLevel_First	First fplLogLevel.
fplLogLevel_Last	Last fplLogLevel.

Definition at line 4172 of file final_platform_layer.h.

fplLogWriterFlags

enum fplLogWriterFlags

An enumeration of log writer flags.

Enumerator
fplLogWriterFlags_None	No appender flags.
fplLogWriterFlags_StandardConsole	Standard-Console output.
fplLogWriterFlags_ErrorConsole	Error-Console output.
fplLogWriterFlags_DebugOut	Debug output.
fplLogWriterFlags_Custom	Custom output.

Definition at line 4208 of file final_platform_layer.h.

Function Documentation

fplGetLogSettings()

fpl_common_api const fplLogSettings * fplGetLogSettings

(

)

Gets the current log settings.

Returns

Returns a pointer the fplLogSettings structure

Note

This function can be called regardless of the initialization state!

See also

Logging

fplGetMaxLogLevel()

fpl_common_api fplLogLevel fplGetMaxLogLevel

(

)

Gets the current maximum allowed log level.

Returns

Returns the current maximum log level fplLogLevel

Note

This function can be called regardless of the initialization state!

See also

Logging

fplSetLogSettings()

fpl_common_api void fplSetLogSettings

(

const fplLogSettings *

params

)

Overwrites the current log settings.

Parameters

params

The source fplLogSettings structure

Note

This function can be called regardless of the initialization state!

See also

Logging

fplSetMaxLogLevel()

fpl_common_api void fplSetMaxLogLevel

(

const fplLogLevel

maxLevel

)

Changes the current maximum log level to the given value.

Parameters

maxLevel

The new maximum log level fplLogLevel

Note

This function can be called regardless of the initialization state!

See also

Logging