OpenVAS Libraries  8.0.3
Functions
openvas_logging.h File Reference
#include <glib.h>
#include <time.h>

Go to the source code of this file.

Functions

GSList * load_log_configuration (gchar *)
 Loads parameters from a config file into a linked list. More...
 
void free_log_configuration (GSList *)
 Frees all resources loaded by the config loader. More...
 
gchar * get_time (gchar *)
 Returns time as specified in time_fmt strftime format. More...
 
void openvas_log_silent (const char *, GLogLevelFlags, const char *, gpointer)
 Returns immediately. More...
 
void openvas_log_func (const char *, GLogLevelFlags, const char *, gpointer)
 Creates the formatted string and outputs it to the log destination. More...
 
void setup_log_handlers (GSList *)
 Sets up routing of logdomains to log handlers. More...
 
void setup_legacy_log_handler (void(*)(const char *, va_list))
 Sets up a simple logging function. More...
 
void log_legacy_write (const char *,...) G_GNUC_PRINTF(1
 
void void log_legacy_fflush (void)
 Legacy function to flush a log message. More...
 

Function Documentation

void free_log_configuration ( GSList *  log_domain_list)

Frees all resources loaded by the config loader.

Parameters
log_domain_listHead of the link list.
gchar* get_time ( gchar *  time_fmt)

Returns time as specified in time_fmt strftime format.

Parameters
time_fmtptr to the string format to use. The strftime man page documents the conversion specification. An example time_fmt string is "%Y-%m-%d %H:%M:%S".
Returns
NULL in case the format string is NULL. A ptr to a string that contains the formatted date time value. This value must be freed using glib's g_free.
GSList* load_log_configuration ( gchar *  config_file)

Loads parameters from a config file into a linked list.

Parameters
config_fileA string containing the path to the configuration file to load.
Returns
NULL in case the config file could not be loaded or an error occurred otherwise, a singly linked list of parameter groups is returned.
void void log_legacy_fflush ( void  )

Legacy function to flush a log message.

This function shall be used instead of fflush for log messages via fprintf. It will eventually be removed.

void log_legacy_write ( const char *  ,
  ... 
)
void openvas_log_func ( const char *  log_domain,
GLogLevelFlags  log_level,
const char *  message,
gpointer  openvas_log_config_list 
)

Creates the formatted string and outputs it to the log destination.

Parameters
log_domainA string containing the message's log domain.
log_levelFlags defining the message's log level.
messageA string containing the log message.
openvas_log_config_listA pointer to the configuration linked list.
Todo:
Move log_separator to the conf file too.
Todo:
Check what error this is.
void openvas_log_silent ( const char *  log_domain,
GLogLevelFlags  log_level,
const char *  message,
gpointer  openvas_log_config_list 
)

Returns immediately.

Parameters
log_domainA string containing the message's log domain.
log_levelFlags defining the message's log level.
messageA string containing the log message.
openvas_log_config_listA pointer to the configuration linked list.
void setup_legacy_log_handler ( void(*)(const char *, va_list)  handler)

Sets up a simple logging function.

The openvas-scanner has not yet been changed to use the new logging facility. However, it uses libary functions and those should use a proper log function instead of writing to stderr. This function can be used to register an existing log handler which will then be used by log_legacy_write.

Parameters
handlerA printf style log handler or NULL to use stderr.
void setup_log_handlers ( GSList *  openvas_log_config_list)

Sets up routing of logdomains to log handlers.

Iterates over the link list and adds the groups to the handler.

Parameters
openvas_log_config_listA pointer to the configuration linked list.