Logging API Interfaces

Modules that require logging must include the header file logger.h.

The following API functions are declared in logger.h:

In addition to the method references, logger.h also contains the datatype:

typedef struct logger_context logger_context;

• log_open
  Initialize RAPLogging API.
• log_init_resource
  Initializes a resource bundle.
• log_message
  Writes the logging message and level into the log file.
• log_rsrc_message
  Logs the message identified by the msgKey key at the specified logging level and against the error code err_num.
• log_close
  Closes the log file and log hierarchy.
• log_init_from_context
  Initializes the RAPLogging API from an existing context created by a previous call to log_open().
• log_get_context
  Returns a pointer to the logger_context used by the current RAPLogging instance.
• log_hexdump
  Formats and logs a traditional memory dump starting at the address supplied and the length supplied. Use the supplied context string at the top and bottom to make it easy to identify. Use the internal logger-> debug function to write it to the current log file.
• log_message_force
  Writes the logging message and level into the log file.
• log_rsrc_message_force
  Writes the logging message identified by the msgKey key at the specified level into the log file, regardless of the filter value of the log level. The msgKey key resides within the resource bundle specified by the rsrc_id parameter.
• log_get_filename
  Retrieve the filename from the log context and return it to the caller.
• log_get_rsrc_message
  Formats and writes to a buffer the message resource identified by msgKey, and returns the length of the buffer required to hold the entire formatted message.