logger.h File Reference

Classes
struct	LogSite
Defines
#define	LOG4CXX
	Author: Roman S.
#define	LOG4CXX_STATIC
#define	HEADER_EMPTY   0
#define	HEADER_TIMESTAMP   1
#define	HEADER_FILELINE   2
#define	HEADER_CATEGORY   4
#define	HEADER_THREAD_ID   8
#define	HEADER_LEVEL   16
#define	HEADER_FUNCTION   32
#define	__LOG4CXX_FUNC__   ""
Typedefs
typedef unsigned	HeaderFormat
	Header format flags.
typedef LogSite	LogSite
Enumerations
enum	LoggingLevel {   DIE = 0, WARN, INFO, LOG,   TRACE }
	Enum of logging levels. More...
enum	CachedState { DISABLED = 0, ENABLED, UNKNOWN }
Functions
VMEXPORT void	init_log_system (void *portLib)
	Inits log system.
VMEXPORT void	shutdown_log_system ()
	shutdown log system.
VMEXPORT void	set_logging_level_from_file (const char *filename)
	Sets loggers logging levels from file.
VMEXPORT void	log4cxx_from_c (const char *category, LoggingLevel level, const char *message, const char *file, const char *func, int line)
	Passes the message specified with level assigned to the category specified for logging.
VMEXPORT void	set_threshold (const char *category, LoggingLevel level)
	Assigns threshold to a category.
VMEXPORT unsigned	is_enabled (const char *category, LoggingLevel level)
	Checks if the logging level specified is enabled for the category given.
VMEXPORT unsigned	is_warn_enabled (const char *category)
VMEXPORT unsigned	is_info_enabled (const char *category)
VMEXPORT unsigned	is_log_enabled (const char *category, LogSite *site)
VMEXPORT unsigned	is_trace_enabled (const char *category, LogSite *site)
VMEXPORT void	set_out (const char *category, const char *file)
	Redirects category (and all subcategories) output to a file.
VMEXPORT void	set_header_format (const char *category, HeaderFormat format)
	Sets the header format for the category specified.
VMEXPORT void	set_thread_specific_out (const char *category, const char *pattern)
	Sets the log file path pattern to use for thread specific logging.
VMEXPORT const char *	log_printf (const char *format,...)
	Write formatted data to a newly allocated string.

---

Define Documentation

#define LOG4CXX

Author:

Roman S.

Bushmanov, Dmitry B. Yershov

Version:

Revision

1.1.2.2.4.3

#define LOG4CXX_STATIC

#define HEADER_EMPTY   0

#define HEADER_TIMESTAMP   1

#define HEADER_FILELINE   2

#define HEADER_CATEGORY   4

#define HEADER_THREAD_ID   8

#define HEADER_LEVEL   16

#define HEADER_FUNCTION   32

#define __LOG4CXX_FUNC__   ""

---

Typedef Documentation

typedef unsigned HeaderFormat

Header format flags.

Binary AND operation should be used to combine flags.

typedef struct LogSite LogSite

---

Enumeration Type Documentation

enum LoggingLevel

Enum of logging levels.

Enumerator:

DIE
WARN
INFO
LOG
TRACE

enum CachedState

Enumerator:

DISABLED
ENABLED
UNKNOWN

---

Function Documentation

VMEXPORT void init_log_system

(

void *

portLib

)

Inits log system.

VMEXPORT void shutdown_log_system

(

)

shutdown log system.

VMEXPORT void set_logging_level_from_file

(

const char *

filename

)

Sets loggers logging levels from file.

VMEXPORT void log4cxx_from_c	(	const char *	category,
		LoggingLevel	level,
		const char *	message,
		const char *	file,
		const char *	func,
		int	line
	)

Passes the message specified with level assigned to the category specified for logging.

VMEXPORT void set_threshold	(	const char *	category,
		LoggingLevel	level
	)

Assigns threshold to a category.

All the messages having a lower logging level will be ignored by the category.

VMEXPORT unsigned is_enabled	(	const char *	category,
		LoggingLevel	level
	)

Checks if the logging level specified is enabled for the category given.

VMEXPORT unsigned is_warn_enabled

(

const char *

category

)

VMEXPORT unsigned is_info_enabled

(

const char *

category

)

VMEXPORT unsigned is_log_enabled	(	const char *	category,
		LogSite *	site
	)

VMEXPORT unsigned is_trace_enabled	(	const char *	category,
		LogSite *	site
	)

VMEXPORT void set_out	(	const char *	category,
		const char *	file
	)

Redirects category (and all subcategories) output to a file.

If the file is NULL, removes previously assigned redirection (if any).

VMEXPORT void set_header_format	(	const char *	category,
		HeaderFormat	format
	)

Sets the header format for the category specified.

Use HeaderFormat flags combined by AND operation to configure format.

VMEXPORT void set_thread_specific_out	(	const char *	category,
		const char *	pattern
	)

Sets the log file path pattern to use for thread specific logging.

Specify NULL pattern to turn off per-thread output. Use t specifier to be replaced by a thread id.

VMEXPORT const char* log_printf	(	const char *	format,
			...
	)

Write formatted data to a newly allocated string.

Use STD_FREE to release allocated memory.

---