Log.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Log_nameValue
struct	trace_settings_type

Macros
#define	LOG_PROTOCOL   TRACE_PROTOCOL
#define	TRACE_MAX   TRACE_MAXIMUM
#define	TRACE_MED   TRACE_MEDIUM
#define	TRACE_MIN   TRACE_MINIMUM

Typedefs
typedef void	Log_traceCallback(enum LOG_LEVELS level, const char *message)

Enumerations
enum	LOG_LEVELS {   INVALID_LEVEL = -1, TRACE_MAXIMUM = 1, TRACE_MEDIUM, TRACE_MINIMUM,   TRACE_PROTOCOL, LOG_ERROR, LOG_SEVERE, LOG_FATAL }

Functions
void	Log (enum LOG_LEVELS, int, const char *,...)
int	Log_initialize (Log_nameValue *)
void	Log_setTraceCallback (Log_traceCallback *callback)
void	Log_setTraceLevel (enum LOG_LEVELS level)
void	Log_stackTrace (enum LOG_LEVELS, int, int, int, const char *, int, int *)
void	Log_terminate (void)

Variables
trace_settings_type	trace_settings

Macro Definition Documentation

#define LOG_PROTOCOL   TRACE_PROTOCOL

Definition at line 64 of file Log.h.

#define TRACE_MAX   TRACE_MAXIMUM

Definition at line 65 of file Log.h.

#define TRACE_MED   TRACE_MEDIUM

Definition at line 67 of file Log.h.

#define TRACE_MIN   TRACE_MINIMUM

Definition at line 66 of file Log.h.

Typedef Documentation

typedef void Log_traceCallback(enum LOG_LEVELS level, const char *message)

Definition at line 81 of file Log.h.

Enumeration Type Documentation

enum LOG_LEVELS

Enumerator
INVALID_LEVEL
TRACE_MAXIMUM
TRACE_MEDIUM
TRACE_MINIMUM
TRACE_PROTOCOL
LOG_ERROR
LOG_SEVERE
LOG_FATAL

Definition at line 35 of file Log.h.

Function Documentation

void Log	(	enum LOG_LEVELS	log_level,
		int	msgno,
		const char *	format,
			...
	)

Log a message. If possible, all messages should be indexed by message number, and the use of the format string should be minimized or negated altogether. If format is provided, the message number is only used as a message label.

Parameters

log_level	the log level of the message
msgno	the id of the message to use if the format string is NULL
aFormat	the printf format string to be used if the message id does not exist
...	the printf inserts

Definition at line 417 of file Log.c.

int Log_initialize

(

Log_nameValue *

)

Definition at line 132 of file Log.c.

void Log_setTraceCallback

(

Log_traceCallback *

callback

)

Definition at line 218 of file Log.c.

void Log_setTraceLevel

(

enum LOG_LEVELS

level

)

Definition at line 224 of file Log.c.

void Log_stackTrace	(	enum LOG_LEVELS	log_level,
		int	msgno,
		int	thread_id,
		int	current_depth,
		const char *	name,
		int	line,
		int *	rc
	)

The reason for this function is to make trace logging as fast as possible so that the function exit/entry history can be captured by default without unduly impacting performance. Therefore it must do as little as possible.

Parameters

log_level	the log level of the message
msgno	the id of the message to use if the format string is NULL
aFormat	the printf format string to be used if the message id does not exist
...	the printf inserts

Definition at line 448 of file Log.c.

void Log_terminate

(

void

)

Definition at line 232 of file Log.c.

Variable Documentation

trace_settings_type trace_settings

Definition at line 67 of file Log.c.