liblogger/liblogger.h File Reference

#include <liblogger/liblogger_levels.h>
#include <liblogger/liblogger_config.h>

Go to the source code of this file.

Defines

#define LIBLOGGER_MAJOR_VERSION   0

#define LIBLOGGER_MINOR_VERSION   1

#define LOG_LEVEL   LOG_LEVEL_TRACE

#define LOG_MODULE_NAME   ""

#define LogFuncEntry()   FuncLogEntry(__func__)

#define LogFuncExit()   FuncLogExit(__func__,__LINE__)

Enumerations

enum LogDest { LogToFile, LogToConsole, LogToSocket }

Functions

int InitLogger (LogDest ldest, void *loggerInitParams)

void DeInitLogger ()

int LogTrace (const char *fmt,...)

int LogDebug (const char *fmt,...)

int LogInfo (const char *fmt,...)

int LogWarn (const char *fmt,...)

int LogError (const char *fmt,...)

int LogFatal (const char *fmt,...)

int FuncLogEntry (const char *funcName)

int FuncLogExit (const char *funcName, const int lineNumber)

Define Documentation

#define LIBLOGGER_MAJOR_VERSION 0

Liblogger major version

Definition at line 30 of file liblogger.h.

#define LIBLOGGER_MINOR_VERSION 1

Liblogger minor version

Definition at line 32 of file liblogger.h.

#define LOG_LEVEL LOG_LEVEL_TRACE

Definition at line 37 of file liblogger.h.

#define LOG_MODULE_NAME ""

Definition at line 42 of file liblogger.h.

#define LogFuncEntry ( ) FuncLogEntry(__func__)

Definition at line 234 of file liblogger.h.

#define LogFuncExit ( ) FuncLogExit(__func__,__LINE__)

Definition at line 235 of file liblogger.h.

Enumeration Type Documentation

enum LogDest

enum which indicates the log destination, used with InitLogger

Enumerator:

LogToFile	Indicates that logging should be done to file.
LogToConsole	Log to Console. (stdout)
LogToSocket	Indicates that logging should be done to socket. Please note that log server should be running.

Definition at line 48 of file liblogger.h.

00049 {
00050         /** Indicates that logging should be done to file. */
00051         LogToFile,
00052         /** Log to Console. (stdout) */
00053         LogToConsole,
00054         /** Indicates that logging should be done to socket. Please note that log server should be 
00055          *  running. */
00056         LogToSocket
00057 }LogDest;

Function Documentation

void DeInitLogger ( )

Function used to deinitialize the logger.

int FuncLogEntry ( const char * funcName )

int FuncLogExit	(	const char *	funcName,
		const int	lineNumber
	)

int InitLogger	(	LogDest	ldest,
		void *	loggerInitParams
	)

Function used to initialize the logger.

Parameters:

`[in]`	ldest	The log destination. see LogDest for possible destinations.
`[in]`	loggerInitParams	The logger initialization parameters.

Returns:: 0 if successful, -1 if there is a failure.

int LogDebug	(	const char *	fmt,
			...
	)

Emit a log with Debug level.

int LogError	(	const char *	fmt,
			...
	)

Emit a log with Error level.

int LogFatal	(	const char *	fmt,
			...
	)

Emit a log with Fatal level.

int LogInfo	(	const char *	fmt,
			...
	)

Emit a log with Info level.

int LogTrace	(	const char *	fmt,
			...
	)

Emit a log with Trace level.

int LogWarn	(	const char *	fmt,
			...
	)

Emit a log with Warn level.


Defines
#define	LIBLOGGER_MAJOR_VERSION 0
#define	LIBLOGGER_MINOR_VERSION 1
#define	LOG_LEVEL LOG_LEVEL_TRACE
#define	LOG_MODULE_NAME ""
#define	LogFuncEntry() FuncLogEntry(__func__)
#define	LogFuncExit() FuncLogExit(__func__,__LINE__)
Enumerations
enum	LogDest { LogToFile, LogToConsole, LogToSocket }
Functions
int	InitLogger (LogDest ldest, void *loggerInitParams)
void	DeInitLogger ()
int	LogTrace (const char *fmt,...)
int	LogDebug (const char *fmt,...)
int	LogInfo (const char *fmt,...)
int	LogWarn (const char *fmt,...)
int	LogError (const char *fmt,...)
int	LogFatal (const char *fmt,...)
int	FuncLogEntry (const char *funcName)
int	FuncLogExit (const char *funcName, const int lineNumber)