LOG

The Logging module. More...

Collaboration diagram for LOG:

Functions
t_status	log_module_supported (void)
	Declares if the module is supported on the current implementation. More...
t_status	log_system_open (const char *source, const char *target, const char *options[], t_log *log)
	Opens a new system log defined by target and log options. More...
t_status	log_system_close (t_log log)
	Closes the system log identified by "log". More...
t_status	log_system_write (t_log log, t_log_level level, t_log_message message)
	Writes a message to the system log (e.g. syslog, event service, etc.) More...
t_status	log_debug_write (t_log log, t_log_message message)
	Writes a message to the system log in DEBUG level. More...
t_status	log_info_write (t_log log, t_log_message message)
	Writes a message to the system log in INFO level. More...
t_status	log_warning_write (t_log log, t_log_message message)
	Writes a message to the system log in WARNING level. More...
t_status	log_error_write (t_log log, t_log_message message)
	Writes a message to the system log in ERROR level. More...
t_status	log_fatal_write (t_log log, t_log_message message)
	Writes a message to the system log in FATAL level. More...

Detailed Description

The Logging module.

---

Function Documentation

log_debug_write()

t_status log_debug_write	(	t_log	log,
		t_log_message	message
	)

Writes a message to the system log in DEBUG level.

Parameters

[in]	log	- The log type
[in]	message	- The message to sent to the system logger

Returns

Operation status

log_error_write()

t_status log_error_write	(	t_log	log,
		t_log_message	message
	)

Writes a message to the system log in ERROR level.

Parameters

[in]	log	- The log type
[in]	message	- The message to sent to the system logger

Returns

Operation status

log_fatal_write()

t_status log_fatal_write	(	t_log	log,
		t_log_message	message
	)

Writes a message to the system log in FATAL level.

Parameters

[in]	log	- The log type
[in]	message	- The message to sent to the system logger

Returns

Operation status

log_info_write()

t_status log_info_write	(	t_log	log,
		t_log_message	message
	)

Writes a message to the system log in INFO level.

Parameters

[in]	log	- The log type
[in]	message	- The message to sent to the system logger

Returns

Operation status

log_module_supported()

t_status log_module_supported

(

void

)

Declares if the module is supported on the current implementation.

Returns

SUCCESS or FAILURE

log_system_close()

t_status log_system_close

(

t_log

log

)

Closes the system log identified by "log".

Parameters

[in]

log

- The log type

Returns

Operation status

log_system_open()

t_status log_system_open	(	const char *	source,
		const char *	target,
		const char *	options[],
		t_log *	log
	)

Opens a new system log defined by target and log options.

Parameters

[in]	source	- The source name, usually the current application name
[in]	target	- The target system log name, e.g. one of the UNIX facilities
[in]	options	- Log options for the system log, array of C-Strings with name of option to pass to the system log service
[out]	log	- The log type

Returns

Operation status

log_system_write()

t_status log_system_write	(	t_log	log,
		t_log_level	level,
		t_log_message	message
	)

Writes a message to the system log (e.g. syslog, event service, etc.)

Parameters

[in]	log	- The log type
[in]	level	- Log level (e.g. DEBUG)
[in]	message	- The message to sent to the system logger

Returns

Operation status

log_warning_write()

t_status log_warning_write	(	t_log	log,
		t_log_message	message
	)

Writes a message to the system log in WARNING level.

Parameters

[in]	log	- The log type
[in]	message	- The message to sent to the system logger

Returns

Operation status